groups

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_typeenumOptional
Filters the groups based on the group type.
Allowed values: dynamicstatic
is_defaultbooleanOptional
Whether to fetch default or custom groups.
limitintegerOptional
The maximum number of groups to return. The default is '50'.
member_typeenumOptional
Filters the groups on basis of member type.
Allowed values: dev_userrev_user
modeenumOptional
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
groups
list of objects
The list of groups.
next_cursor
stringOptional
The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.
prev_cursor
stringOptional
The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.
Built with