sys-users

List

GET
Lists system users within your organization.

Query parameters

cursorstringOptional
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
limitintegerOptional
The maximum number of system users to return. Value can range from '1' to '100', with a default of '50'.
modeenumOptional
The iteration mode to use, otherwise if not set, then "after" is used.
Allowed values: afterbefore
sort_bystringOptional
Fields to sort the system users by and the direction to sort them.

Response

This endpoint returns an object
sys_users
list of objects
The list of system users.
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/sys-users.list \
2     -H "Authorization: <apiKey>"
200
Retrieved
1{
2  "sys_users": [
3    {
4      "id": "id",
5      "created_date": "2023-01-01T12:00:00Z",
6      "display_id": "display_id",
7      "display_name": "display_name",
8      "display_picture": {
9        "id": "id"
10      },
11      "email": "email",
12      "full_name": "full_name",
13      "modified_date": "2023-01-01T12:00:00Z",
14      "phone_numbers": [
15        "phone_numbers"
16      ],
17      "state": "active"
18    }
19  ],
20  "next_cursor": "next_cursor",
21  "prev_cursor": "prev_cursor"
22}
Built with