dev-users

List Post

POST
Lists 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.
email
list of stringsOptional
Filters Dev users based on email addresses.
external_identity
list of objectsOptional
Filters Dev users based on external identity.
limit
integerOptional
The maximum number of Dev users to return. The default is '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 Dev users by and the direction to sort them.
state
list of enumsOptional
Filters Dev users based on state.

Response

This endpoint returns an object
dev_users
list of objects
The list of Dev 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/dev-users.list \
2 -H "Authorization: <apiKey>" \
3 -H "Content-Type: application/json" \
4 -d '{}'
200Successful
1{
2 "dev_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 "external_identities": [
13 {}
14 ],
15 "full_name": "full_name",
16 "modified_date": "2023-01-01T12:00:00Z",
17 "phone_numbers": [
18 "phone_numbers"
19 ],
20 "state": "active"
21 }
22 ],
23 "next_cursor": "next_cursor",
24 "prev_cursor": "prev_cursor"
25}