rev-users

List

GET
Returns a list of all Rev Users belonging to the authenticated user's Dev Organization.

Query parameters

created_bystringOptional
Filters for Rev users that were created by the specified user(s).
created_date.afterdatetimeOptional
Filters for objects created after the provided timestamp (inclusive).
created_date.beforedatetimeOptional
Filters for objects created before the provided timestamp (inclusive).
cursorstringOptional
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
custom_fieldsmap from strings to anyOptional
Filters for custom fields.
emailstringOptional
List of emails of Rev users to be filtered.
external_refstringOptional
List of external refs to filter Rev users for.
is_verifiedbooleanOptional

Value of is_verified field to filter the Rev users.

limitintegerOptional
The maximum number of Rev users to return. The default is '50'.
modeenumOptional
The iteration mode to use, otherwise if not set, then "after" is used.
Allowed values: afterbefore
modified_date.afterdatetimeOptional
Filters for objects created after the provided timestamp (inclusive).
modified_date.beforedatetimeOptional
Filters for objects created before the provided timestamp (inclusive).
phone_numbersstringOptional
List of phone numbers, in E.164 format, to filter Rev users on.
rev_orgstringOptional
List of IDs of Rev organizations to be filtered.
sort_bystringOptional
Fields to sort the Rev users by and the direction to sort them.
tagsstringOptional
List of tags to be filtered.

Response

This endpoint returns an object
rev_users
list of objects
List containing all the Rev 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 -G https://api.devrev.ai/rev-users.list \
2     -H "Authorization: <apiKey>" \
3     --data-urlencode created_date.after=2023-01-01T12:00:00Z \
4     --data-urlencode created_date.before=2023-01-01T12:00:00Z \
5     --data-urlencode modified_date.after=2023-01-01T12:00:00Z \
6     --data-urlencode modified_date.before=2023-01-01T12:00:00Z
200
Retrieved
1{
2  "rev_users": [
3    {
4      "id": "id",
5      "artifacts": [
6        {
7          "id": "id"
8        }
9      ],
10      "created_date": "2023-01-01T12:00:00Z",
11      "custom_schema_fragments": [
12        "custom_schema_fragments"
13      ],
14      "description": "description",
15      "display_id": "display_id",
16      "display_name": "display_name",
17      "display_picture": {
18        "id": "id"
19      },
20      "email": "email",
21      "external_ref": "external_ref",
22      "full_name": "full_name",
23      "is_verified": true,
24      "modified_date": "2023-01-01T12:00:00Z",
25      "phone_numbers": [
26        "phone_numbers"
27      ],
28      "state": "active",
29      "stock_schema_fragment": "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>",
30      "subtype": "subtype",
31      "tags": [
32        {
33          "tag": {
34            "id": "id",
35            "name": "name"
36          }
37        }
38      ]
39    }
40  ],
41  "next_cursor": "next_cursor",
42  "prev_cursor": "prev_cursor"
43}
Built with