dev-users

List

GET
Lists users within your organization.

Query parameters

cursorstringOptional
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
emailstringOptional
Filters Dev users based on email addresses.
external_identity.idstringOptional
Unique ID of the user in the external source.
external_identity.issuerstringOptional
Issuer of the external identity of the user.
limitintegerOptional
The maximum number of Dev users to return. The default is '50'.
modeenumOptional
The iteration mode to use, otherwise if not set, then "after" is used.
Allowed values: afterbefore
sort_bystringOptional
Fields to sort the Dev users by and the direction to sort them.
stateenumOptional
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.
GET
1curl https://api.devrev.ai/dev-users.list \
2     -H "Authorization: <apiKey>"
Response
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}
Built with