List Sys Users (POST) | DevRev

1 curl -X POST https://api.devrev.ai/sys-users.list \ 2 -H "Authorization: Bearer <token>" \ 3 -H "Content-Type: application/json" \ 4 -d '{}'

1 { 2 "sys_users": [ 3 { 4 "id": "foo", 5 "created_by": { 6 "display_id": "foo", 7 "id": "foo", 8 "display_name": "foo", 9 "display_picture": { 10 "display_id": "foo", 11 "id": "foo", 12 "file": { 13 "type": "foo", 14 "name": "foo", 15 "size": 42 16 } 17 }, 18 "email": "foo", 19 "full_name": "foo", 20 "state": "active" 21 }, 22 "created_date": "2023-01-01T12:00:00.000Z", 23 "display_id": "foo", 24 "display_name": "foo", 25 "display_picture": { 26 "id": "foo", 27 "display_id": "foo", 28 "file": { 29 "type": "foo", 30 "name": "foo", 31 "size": 42 32 } 33 }, 34 "email": "foo", 35 "full_name": "foo", 36 "modified_by": { 37 "display_id": "foo", 38 "id": "foo", 39 "display_name": "foo", 40 "display_picture": { 41 "display_id": "foo", 42 "id": "foo", 43 "file": { 44 "type": "foo", 45 "name": "foo", 46 "size": 42 47 } 48 }, 49 "email": "foo", 50 "full_name": "foo", 51 "state": "active" 52 }, 53 "modified_date": "2023-01-01T12:00:00.000Z", 54 "phone_numbers": [ 55 "foo" 56 ], 57 "primary_identity": { 58 "display_id": "foo", 59 "id": "foo", 60 "display_name": "foo", 61 "display_picture": { 62 "display_id": "foo", 63 "id": "foo", 64 "file": { 65 "type": "foo", 66 "name": "foo", 67 "size": 42 68 } 69 }, 70 "email": "foo", 71 "full_name": "foo", 72 "state": "active" 73 }, 74 "state": "active" 75 } 76 ], 77 "next_cursor": "foo", 78 "prev_cursor": "foo" 79 }

Lists system users within your organization.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

cursorstringOptionalformat: "text"

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. 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:

sort_bylist of stringsOptional

Fields to sort the system users by and the direction to sort them.

Response

The response to listing the system users.

sys_userslist of objects

The list of system users.

next_cursorstring or nullformat: "text"

The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.

prev_cursorstring or nullformat: "text"

The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.

Headers

Request

Response

Errors