Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
User

user.list

Lists all users in the organization with pagination support.

By default, only active (enabled) users are returned. Use includeDeactivated: true to include deactivated users.

Supports incremental sync via syncToken to efficiently retrieve only users updated since the last sync.

Requires the organizationRead permission.

post/user.list

Request body

includeDeactivatedboolean

Whether to include deactivated users in the results. Defaults to false.

cursorstring nullable

The pagination cursor. Use 'start' for the first page or the nextCursor value from a previous response.

limitinteger

The maximum number of users to return per page. Maximum is 100.

syncTokenstring nullable

A sync token to retrieve only users updated since the last sync. Obtained from a previous list response.

Example request

{
  "cursor": "G8",
  "limit": 25,
  "syncToken": "jYnEBmjzR"
}

Response

Responses from the user.list endpoint

OR

Example response

{
  "success": true,
  "results": [
    {
      "id": "3c5e1e9f-17b5-4c8e-8d1a-9f6e4b3a2c1d",
      "firstName": "Jane",
      "lastName": "Smith",
      "email": "jane.smith@example.com",
      "globalRole": "Elevated Access",
      "isEnabled": true,
      "updatedAt": "2024-01-15T10:30:00.000Z",
      "managerId": "7f8e9d6c-5b4a-4e2d-9c0b-9a8f7e6d5c4b"
    }
  ],
  "moreDataAvailable": false,
  "syncToken": "sync-token-example"
}