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 displayName eq "..." is applied; anything else is ignored and the full page is returned.

startIndex
integer
default:1

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

count
integer
default:100

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: 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[]

The SCIM schema URNs this resource conforms to.

totalResults
integer

How many resources match, before pagination.

startIndex
integer
itemsPerPage
integer
Resources
object[]