• About
    • For Developers
  • API Reference
    • Changelog
  • Guides
    • Account creation
    • Agents async API
    • Links
API Referencerev-users

List Rev Users

GET
https://api.devrev.ai/rev-users.list
GET
/rev-users.list
1curl https://api.devrev.ai/rev-users.list \
2     -H "Authorization: Bearer <token>"
Try it
200Retrieved
1{
2  "rev_users": [
3    {
4      "id": "string",
5      "artifacts": [
6        {
7          "id": "string",
8          "display_id": "string",
9          "file": {
10            "type": "string",
11            "name": "string",
12            "size": 1
13          }
14        }
15      ],
16      "created_by": {
17        "display_id": "string",
18        "id": "string",
19        "display_name": "string",
20        "display_picture": {
21          "display_id": "string",
22          "id": "string",
23          "file": {
24            "type": "string",
25            "name": "string",
26            "size": 1
27          }
28        },
29        "email": "string",
30        "full_name": "string",
31        "state": "active"
32      },
33      "created_date": "2023-01-01T12:00:00.000Z",
34      "custom_fields": {},
35      "custom_schema_fragments": [
36        "don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id"
37      ],
38      "description": "string",
39      "display_id": "string",
40      "display_name": "string",
41      "display_picture": {
42        "id": "string",
43        "display_id": "string",
44        "file": {
45          "type": "string",
46          "name": "string",
47          "size": 1
48        }
49      },
50      "email": "string",
51      "external_ref": "string",
52      "external_refs": [
53        "string"
54      ],
55      "full_name": "string",
56      "is_verified": true,
57      "modified_by": {
58        "display_id": "string",
59        "id": "string",
60        "display_name": "string",
61        "display_picture": {
62          "display_id": "string",
63          "id": "string",
64          "file": {
65            "type": "string",
66            "name": "string",
67            "size": 1
68          }
69        },
70        "email": "string",
71        "full_name": "string",
72        "state": "active"
73      },
74      "modified_date": "2023-01-01T12:00:00.000Z",
75      "phone_numbers": [
76        "string"
77      ],
78      "primary_identity": {
79        "display_id": "string",
80        "id": "string",
81        "display_name": "string",
82        "display_picture": {
83          "display_id": "string",
84          "id": "string",
85          "file": {
86            "type": "string",
87            "name": "string",
88            "size": 1
89          }
90        },
91        "email": "string",
92        "full_name": "string",
93        "state": "active"
94      },
95      "rev_org": {
96        "display_id": "string",
97        "id": "string",
98        "display_name": "string"
99      },
100      "state": "active",
101      "stock_schema_fragment": "don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id",
102      "subtype": "string",
103      "tags": [
104        {
105          "tag": {
106            "id": "string",
107            "name": "string",
108            "display_id": "string",
109            "style_new": {
110              "color": "string"
111            }
112          },
113          "value": "string"
114        }
115      ]
116    }
117  ],
118  "next_cursor": "string",
119  "prev_cursor": "string"
120}
Returns a list of all Rev Users belonging to the authenticated user's Dev organization.

Headers

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

Query parameters

associationslist of stringsOptional
Filters for Rev users with specified associations (account/workspace).
created_bylist of stringsOptional
Filters for Rev users that were created by the specified user(s).
created_date.afterstringOptionalformat: "date-time"
Filters for objects created after the provided timestamp (inclusive).
created_date.beforestringOptionalformat: "date-time"
Filters for objects created before the provided timestamp (inclusive).
cursorstringOptionalformat: "text"
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
custom_fieldsobjectOptional
Filters for custom fields.
emaillist of stringsOptional
List of emails of Rev users to be filtered.
external_reflist of stringsOptional
List of external refs to filter Rev users for.
external_refslist of stringsOptional
Filters for Rev users with the provided external_refs.
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:
modified_date.afterstringOptionalformat: "date-time"
Filters for objects created after the provided timestamp (inclusive).
modified_date.beforestringOptionalformat: "date-time"
Filters for objects created before the provided timestamp (inclusive).
phone_numberslist of stringsOptional
List of phone numbers, in E.164 format, to filter Rev users on.
rev_orglist of stringsOptional
List of IDs of Rev organizations to be filtered.
sort_bylist of stringsOptional
Fields to sort the Rev users by and the direction to sort them.
tagslist of stringsOptional
List of tags to be filtered.

Response

The response to listing all Rev users matching the filter criteria.
rev_userslist of objects
List containing all the Rev 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.

Errors

Was this page helpful?
Previous

List Rev Users (POST)

Next
Built with
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
Filters for custom fields.
List of emails of Rev users to be filtered.
List of external refs to filter Rev users for.
The maximum number of Rev users to return. The default is '50'.
The iteration mode to use, otherwise if not set, then "after" is used.
List of phone numbers, in E.164 format, to filter Rev users on.
List of IDs of Rev organizations to be filtered.
Fields to sort the Rev users by and the direction to sort them.
List of tags to be filtered.
The response to listing all Rev users matching the filter criteria.

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

Filters for objects created before the provided timestamp (inclusive).

Filters for objects created before the provided timestamp (inclusive).

Filters for Rev users with the provided external_refs.

List Rev Users (POST)

Filters for Rev users with specified associations (account/workspace).

Filters for Rev users that were created by the specified user(s).

Filters for objects created after the provided timestamp (inclusive).

Filters for objects created after the provided timestamp (inclusive).

Value of is_verified field to filter the Rev users.