Scan

GET

Scans through all Rev users.

Query parameters

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

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.

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.

tagsstringOptional

List of tags to be filtered.

Response

This endpoint returns an object.
rev_userslist of objects

The iterated Rev users.

next_cursorstringOptional

The cursor that should be used to resume iteration, otherwise if not provided, then iteration has completed.