Sign in

v1

latestOpenAPI 3.1.02026-07-242735131.1 MB
SCIM

List users via SCIM v2.0

Retrieves a list of users for the authenticated company following SCIM 2.0 standard

get/v1/scim/v2/Users

Query parameters

startIndexinteger

1-based index of the first result

countinteger

Maximum number of results per page

filterstring

Filter expression for attributes (supports eq, ne, co, sw, ew, pr, lt, le, gt, ge)

Response

Success

itemsPerPageinteger required

Number of results returned in the current set

schemasstring[] required

SCIM schema identifiers

startIndexinteger required

1-based index of the first result in the current set

totalResultsinteger required

Total number of results matching the query

Example response

{
  "Resources": [
    {
      "active": true,
      "department": "Engineering",
      "emails": [
        {
          "primary": true,
          "type": "work",
          "value": "john.doe@example.com"
        }
      ],
      "employeeNumber": "EMP001",
      "id": "123456",
      "manager": {
        "displayName": "Jane Manager",
        "value": "789012"
      },
      "meta": {
        "created": "2023-01-01T00:00:00Z",
        "lastModified": "2023-01-01T00:00:00Z",
        "resourceType": "User"
      },
      "name": {
        "familyName": "Doe",
        "formatted": "John Doe",
        "givenName": "John"
      },
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User",
        "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
      ],
      "userName": "john.doe@example.com"
    }
  ],
  "itemsPerPage": 50,
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "startIndex": 1,
  "totalResults": 100
}