API ReferenceRev Users

Scan Rev Users

Scans through all Rev users.

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, otherwise the beginning if not provided.
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.

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.

Response

The response to scanning Rev users.
rev_userslist of objects
The iterated Rev users.
next_cursorstring or nullformat: "text"
The cursor that should be used to resume iteration, otherwise if not provided, then iteration has completed.

Errors