Skip to main content
List groups visible to your workspace, cursor-paginated. Pass external_entity_id to look up a single group by its external identifier.

Query parameters

string
Filter results to groups whose metadata.external_entity_id matches this value exactly. Because external_entity_id is unique per workspace, the response contains at most one item. Combinable with limit and cursor.
integer
Page size. Default 100, maximum 1000.
string
Pagination cursor from the previous response’s pagination.cursor. Omit on the first call.

Errors

Authorizations

Authorization
string
header
required

Send Authorization: Bearer <api_key>. The legacy Authorization: Api-Key <api_key> scheme is also accepted.

Response

200 - application/json
items
GroupV1 · object[]
required

Items in this page.

pagination
PaginationResponseV1 · object
required

Pagination metadata for the page.