Sign in
SCIM

List SCIM groups

List SCIM groups for the organization. Management key required.

get/scim/groups

Query parameters

offsetinteger nullable

Number of records to skip for pagination

Number of records to skip for pagination

limitinteger

Maximum number of records to return (max 100)

Example:50

Maximum number of records to return (max 100)

display_namestring

Exact match filter on display_name. Omitted or empty returns groups unfiltered by name (subject to offset/limit). When external_id is also present, both must match.

Example:Engineering

Exact match filter on display_name. Omitted or empty returns groups unfiltered by name (subject to offset/limit). When external_id is also present, both must match.

external_idstring

Exact match filter on external_id, e.g. the identity provider (such as Entra ID) group object ID. Omitted or empty returns groups unfiltered by external_id (subject to offset/limit). When display_name is also present, both must match.

Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890

Exact match filter on external_id, e.g. the identity provider (such as Entra ID) group object ID. Omitted or empty returns groups unfiltered by external_id (subject to offset/limit). When display_name is also present, both must match.

Response

List of SCIM groups

total_countinteger required

Example response

{
  "data": [
    {
      "created_at": "2025-08-24T10:30:00.000Z",
      "display_name": "Engineering",
      "external_id": "group-external-id",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "organization_id": "org_123456",
      "updated_at": "2025-08-24T10:30:00.000Z"
    }
  ]
}

Changes