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
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.
GET
1curl https://api.devrev.ai/groups.list \
2     -H "Authorization: <apiKey>"
200
Retrieved
1{
2  "groups": [
3    {
4      "id": "id",
5      "is_default": true,
6      "created_date": "2023-01-01T12:00:00Z",
7      "description": "description",
8      "display_id": "display_id",
9      "member_type": "dev_user",
10      "modified_date": "2023-01-01T12:00:00Z",
11      "name": "name"
12    }
13  ],
14  "next_cursor": "next_cursor",
15  "prev_cursor": "prev_cursor"
16}
Built with