Skip to main content
GET
List SCIM groups

Authorizations

Authorization
string
header
required

API key as bearer token in Authorization header

Query Parameters

offset
integer | null
default:0

Number of records to skip for pagination

Required range: x >= 0
Example:

0

limit
integer
default:50

Maximum number of records to return (max 100)

Required range: 1 <= x <= 100
Example:

50

display_name
string

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"

external_id
string

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"

Response

List of SCIM groups

data
object[]
required
total_count
integer
required