sys-users

List Post

POST
Lists system users within your organization.

Request

This endpoint expects an object.
cursor
stringOptional
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
limit
integerOptional
The maximum number of system users to return. Value can range from '1' to '100', with a default of '50'.
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
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.
POST
1curl -X POST https://api.devrev.ai/sys-users.list \
2     -H "Authorization: <apiKey>" \
3     -H "Content-Type: application/json" \
4     -d '{}'
200
Successful
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