Sign in
latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

Users

Gets a list of users

Retrieve a paged collection of users (required scope users:read)

get/v1/users

Query parameters

sortBy'emailAddress'

Represents the fields that can be used to sort users<p>Possible values:</p><ul><li><b>emailAddress</b>: The email address of the user</li></ul>

Example:emailAddress

The field to sort items in the page by

direction'ascending' | 'descending'

Represents the direction in which sorting should be applied<p>Possible values:</p><ul><li><b>ascending</b>: Indicates ascending sorting order</li><li><b>descending</b>: Indicates descending sorting order</li></ul>

Example:ascending

The direction to apply the sort

pageNumberinteger

The page number being requested (minimum: 1, maximum: 2147483)

pageSizeinteger

The page size being requested (minimum: 1, maximum: 1000)

emailAddressstring

The email address to filter users by

Headers

Customer-Idinteger required

The customer identifier

Response

OK

pageNumberinteger

The page number of the response where 1 is the first page

pageSizeinteger

The number of items requested for the current page

pageItemCountinteger

The number of items returned in the current page

Example response

{
  "items": [
    {
      "id": 123456,
      "email": "email@example.com",
      "name": "John Doe",
      "createdAt": "2023-12-01T13:00:00.0000000+00:00",
      "roleId": 12345,
      "position": "Engineer",
      "type": "active",
      "groupId": 67890,
      "mobile": "+447700900123",
      "customFields": [
        {
          "definitionId": 5514123,
          "value": "Purple",
          "definition": {
            "caption": "Favourite colour",
            "type": "boolean",
            "listOptions": [
              "Red",
              "Blue",
              "Green",
              "Purple"
            ],
            "isRequired": true,
            "isEditable": true,
            "default": "10"
          },
          "systemListValueMetadata": {
            "label": "John Doe",
            "entityType": "resource"
          }
        }
      ]
    }
  ],
  "pageNumber": 2,
  "pageSize": 100,
  "pageItemCount": 55
}