Skip to main content
GET
List provisioned groups

Authorizations

Authorization
string
header
required

SCIM token for one organization's directory connection, created with POST /api/scim-tokens or in Settings > SCIM. It authenticates provisioning calls only, and stops working if the organization's Enterprise plan lapses.

Query Parameters

filter
string

A SCIM filter. Only attribute eq "..." is understood; any other expression is refused.

startIndex
integer

1-based index of the first resource to return. Anything that does not parse as a positive integer is read as 1.

Required range: -9007199254740991 <= x <= 9007199254740991
count
integer

How many resources to return, capped at 100 (the filter.maxResults ServiceProviderConfig publishes). Anything that does not parse as a positive integer is read as 100, and anything above 100 is served as 100.

Required range: -9007199254740991 <= x <= 100
excludedAttributes
string

Comma-separated attribute names to leave out of the response. Only members is honoured, and it is what lets a directory page through groups without pulling every membership.

Response

A page of provisioned groups.

schemas
string[]
required
Allowed value: "urn:ietf:params:scim:api:messages:2.0:ListResponse"
totalResults
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
startIndex
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
itemsPerPage
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
Resources
object[]
required
Last modified on August 10, 2026