Groups

Return list of groups

Returns a paginated list of groups in the organization. Archived groups are included by default and can be excluded via the include_archived_groups parameter.

Token scopes: groups:read

get/groups

Request

  • Base URL: https://api.letsdeel.com/rest
  • URL: https://api.letsdeel.com/rest/groups
  • Auth: HTTP bearer

Query parameters

limitinteger

The maximum number of groups to return (between 1 and 100)

sort_order'ASC' | 'DESC'

Sort the results in ascending (ASC) or descending (DESC) order based on the group name.

cursorstring

The encoded cursor for paginated results. This is an opaque string that allows fetching the next set of results.

include_archived_groupsboolean

Include archived groups (soft deleted records). Defaults to true.

external_metadatastring

Extra information about the group.

Response

A list of groups in the organization.

Changes

No recorded changes to this operation across all 1 revision of this API.