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_bylist of stringsOptional

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

created_dateobjectOptional
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.

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’.

mode"after" or "before"Optional
Allowed values: afterbefore

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.

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.

tagslist of stringsOptional

List of tags to be filtered.

Response

This endpoint returns an object.
rev_userslist of objects

List containing all the Rev users.

next_cursorstringOptional

The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.

prev_cursorstringOptional

The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.