Skip to main content
POST
ListEntityGroups

Authorizations

Authorization
string
header
required

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

Body

application/json
pagination
Pagination · object | null

Pagination. Omitting this, or sending a zero page_size, returns every group in one response — there is no server-side default page size. A group carries every one of its member identifiers, so a workspace with large groups is worth paging even though the group count is small. Pass page_info.last_id from the previous response as the cursor to fetch the next page.

Response

200 - application/json

Success

entitiesGroups
Group · object[]
pageInfo
PageInfo · object

Paging information for this response. Always populated. Repeat the request passing page_info.last_id as pagination.cursor until last_id comes back empty to walk the whole workspace.