List Rev Users

GET

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

Query parameters

associationsstringOptional

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

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

mode"after" or "before"Optional

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

The response to listing all Rev users matching the filter criteria.

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.

Built with