groups

List Post

POST
Lists the available groups.

Request

This endpoint expects an object.
cursor
stringOptional
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
group_type
list of enumsOptional
Filters the groups based on the group type.
Allowed values: dynamicstatic
limit
integerOptional
The maximum number of groups to return. The default is '50'.
member_type
list of enumsOptional
Filters the groups on basis of member type.
Allowed values: dev_userrev_user
mode
enumOptional
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.
Allowed values: afterbefore
sort_by
list of stringsOptional
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.
POST
1curl -X POST https://api.devrev.ai/groups.list \
2     -H "Authorization: <apiKey>" \
3     -H "Content-Type: application/json" \
4     -d '{}'
200
Successful
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