List Post

POST

Lists the available groups.

Request

This endpoint expects an object.
cursorstringOptional

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

group_typelist of "dynamic" or "static"Optional
Allowed values: dynamicstatic

Filters the groups based on the group type.

ingestion_sourcelist of "airdrop" or "scim"Optional
Allowed values: airdropscim

Filter groups by ingestion source(s).

is_defaultbooleanOptional

Whether to fetch default or custom groups.

limitintegerOptional

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

member_typelist of "dev_user" or "rev_user"Optional
Allowed values: dev_userrev_user

Filters the groups on basis of member type.

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

The iteration mode to use. If “after”, then entries after the provided cursor will be returned, or if no cursor is provided, then from the beginning. If “before”, then entries before the provided cursor will be returned, or if no cursor is provided, then from the end. Entries will always be returned in the specified sort-by order.

sort_bylist of stringsOptional

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.