GET/organization/groups

List organization groups

Lists groups in the organization, with controls for page size, cursor position, and sort order. Use after with a group ID from the previous page to continue through the results.

3 parameters
limitintegeroptional
Maximum number of groups to return, from 0 to 1000. Defaults to 100 when omitted.
Default:100
afterstringoptional
Group ID cursor that marks the position to continue listing from; use the last group ID from the previous page.
orderstringoptional
Sort order for returned groups: `asc` or `desc`. Defaults to `asc` when omitted.
Allowed:ascdescDefault:asc

5 status codes
200Returns a page of groups with each group's ID, name, creation time, SCIM management status, and type, along with `has_more` and the `next` cursor.
objectstringrequired
Always `list`.
Allowed:list
dataarray<object>required
Groups returned in the current page.
has_morebooleanrequired
Whether additional groups are available when paginating.
nextstringrequired
Cursor to fetch the next page of results, or `null` if there are no more results.
400Returned when request parameters are invalid or the requested operation cannot be performed.
errorobjectrequired
403Returned when the caller does not have permission to list organization groups.
errorobjectrequired
Details about the permission error.
404Returned when the endpoint is unavailable or a requested group, user, or project is not found.
errorobjectrequired
429Returned when the request exceeds a rate limit.
errorobjectrequired

Error handling

A 400 is returned when query parameters are invalid or the requested operation cannot be performed. A 403 is returned when the authenticated user lacks permission to list groups. A 404 is returned when the endpoint is unavailable or a requested group, user, or project is not found. A 429 is returned when the request exceeds a rate limit. limit must be between 0 and 1000, and order must be asc or desc.