Skip to main content
GET
List Workspace Groups

Authentication and permissions

Token requirements: User-based token (OAuth) or Organization-scoped API key. Send a bearer access token for one of these identities. The permissions and resource restrictions below also apply.
Permissions joined by + are all required; or separates alternatives. Full-access keys still cannot call endpoints marked unsupported. Workspace keys must allow every workspace checked by the request. OAuth access depends on the user’s roles and resource access.

Authorizations

Authorization
string
header
required

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

Path Parameters

team_id
string
required

Filter by workspace ID. Required when using the /v2/teams/{team_id}/groups path.

Query Parameters

groupId
string

Filter by group ID. Returns the group's bindings across every workspace.

pageSize
integer<int32>

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

pageToken
string

Token for pagination. Leave empty for the first request. Only honored when filtering by team_id alone; the group_id shape is unpaginated.

Response

200 - application/json

Success

data
TeamGroup · object[]

The list of workspace groups.

nextPageToken
string | null

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