Skip to main content
GET
List Groups

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

pageSize
integer<int32>

Maximum number of results to return. Default is 100, maximum is 10000.

pageToken
string

Token for pagination. Leave empty for the first request.

userId
string

Filter to the groups this user is a member of. Each returned group still carries its full user_ids roster, not just this user.

teamId
string

Configuration-team namespace, not manager ACL. Unset lists org-visible groups.

groupIds
string[]

Resolve only these group UUIDs and team-scoped portable IDs.

scopedIds
string[]
omitMembers
boolean

Omit the user roster when only group identity and configuration are needed.

Response

200 - application/json

Success

data
Group · object[]

The list of groups.

nextPageToken
string | null

Token for retrieving the next page of results. Empty if no more results.