List

GET

Lists the available groups.

Query parameters

cursorstringOptional

The cursor to resume iteration from. If not provided, then iteration starts from the beginning.

group_type"dynamic" or "static"Optional

Filters the groups based on the group type.

Allowed values: dynamicstatic
ingestion_source"airdrop" or "scim"Optional

Filter groups by ingestion source(s).

Allowed values: airdropscim
is_defaultbooleanOptional

Whether to fetch default or custom groups.

limitintegerOptional

The maximum number of groups to return. The default is ‘50’.

member_type"dev_user" or "rev_user"Optional

Filters the groups on basis of member type.

Allowed values: dev_userrev_user
mode"after" or "before"Optional

The iteration mode to use, otherwise if not set, then “after” is used.

Allowed values: afterbefore
sort_bystringOptional

Comma-separated fields to sort the groups by.

Response

This endpoint returns an object.
groupslist of objects

The list of groups.

next_cursorstringOptional

The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.

prev_cursorstringOptional

The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.