rev-users

List Post

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

Request

This endpoint expects an object.
created_by
list of stringsOptional
Filters for Rev users that were created by the specified user(s).
created_date
objectOptional
cursor
stringOptional
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
custom_fields
map from strings to anyOptional
Filters for custom fields.
email
list of stringsOptional
List of emails of Rev users to be filtered.
external_ref
list of stringsOptional
List of external refs to filter Rev users for.
is_verified
booleanOptional

Value of is_verified field to filter the Rev users.

limit
integerOptional
The maximum number of Rev 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
modified_date
objectOptional
phone_numbers
list of stringsOptional
List of phone numbers, in E.164 format, to filter Rev users on.
rev_org
list of stringsOptional
List of IDs of Rev organizations to be filtered.
sort_by
list of stringsOptional
Fields to sort the Rev users by and the direction to sort them.
tags
list of stringsOptional
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.
POST
1curl -X POST https://api.devrev.ai/rev-users.list \
2     -H "Authorization: <apiKey>" \
3     -H "Content-Type: application/json" \
4     -d '{}'
200
Successful
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