Sign in
Groups

List groups

Lists all groups in the organization.

get/organization/groups

Query parameters

limitinteger

A limit on the number of groups to be returned. Limit can range between 0 and 1000, and the default is 100.

afterstring

A cursor for use in pagination. after is a group ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with group_abc, your subsequent call can include after=group_abc in order to fetch the next page of the list.

order'asc' | 'desc'

Specifies the sort order of the returned groups.

Response

Groups listed successfully.

object'list' required

Always list.

has_moreboolean required

Whether additional groups are available when paginating.

nextstring nullable required

Cursor to fetch the next page of results, or null if there are no more results.

Changes

Changed in 5 of the 163 revisions of this API.26

  • d86203de41ae3See the full diff
    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

  • 9430b00d75b41See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

  • 6ac2618eefd71See the full diff
    • ○

      added the non-success response with the status

      response-non-success-status-added

  • ab0c5306e3902See the full diff
    • ●

      added the new group enum value to the // response property for the response status

      response-property-enum-value-added

    • ●

      added the new tenant_group enum value to the // response property for the response status

      response-property-enum-value-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 74cbcf73838f1See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 40 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog