API ReferenceRev Users

List Rev Users (POST)

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.

Request

This endpoint expects an object.
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_dateobjectOptional
cursorstringOptionalformat: "text"
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
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.
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. 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:
modified_dateobjectOptional
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.

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