Scan Rev Users
Scans through all Rev users.
All the DevRev APIs require a token to authenticate the user. Provide Authorization: Bearer <TOKEN> as a header to every API request.
How do I find my token?
In: header
Query Parameters
Filters for Rev users with specified associations (account/workspace).
Filters for Rev users that were created by the specified user(s).
Filters for objects created after the provided timestamp (inclusive).
date-timeFilters for objects created before the provided timestamp (inclusive).
date-timeThe cursor to resume iteration, otherwise the beginning if not provided.
textList of emails of Rev users to be filtered.
List of external refs to filter Rev users for.
Value of is_verified field to filter the Rev users.
Filters for objects created after the provided timestamp (inclusive).
date-timeFilters for objects created before the provided timestamp (inclusive).
date-timeList of phone numbers, in E.164 format, to filter Rev users on.
List of IDs of Rev organizations to be filtered.
Response Body
curl -X GET "https://api.devrev.ai/rev-users.scan?associations=string&created_by=string&created_date.after=2023-01-01T12%3A00%3A00.000Z&created_date.before=2023-01-01T12%3A00%3A00.000Z&cursor=string&email=string&external_ref=string&is_verified=true&modified_date.after=2023-01-01T12%3A00%3A00.000Z&modified_date.before=2023-01-01T12%3A00%3A00.000Z&phone_numbers=string&rev_org=REV-AbCdEfGh"{
"next_cursor": "string",
"rev_users": [
{
"created_by": {
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
},
"created_date": "2023-01-01T12:00:00.000Z",
"display_id": "string",
"id": "string",
"modified_by": {
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
},
"modified_date": "2023-01-01T12:00:00.000Z",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"phone_numbers": [
"string"
],
"primary_identity": {
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
},
"state": "active",
"description": "string",
"external_ref": "string",
"rev_org": {
"type": "rev_org",
"display_id": "string",
"id": "string",
"display_name": "string"
}
}
]
}{
"detail": "string",
"message": "string",
"type": "artifact_already_attached_to_a_parent",
"existing_parent": "string",
"is_same": true
}{
"detail": "string",
"message": "string",
"type": "unauthenticated"
}{
"detail": "string",
"message": "string",
"type": "forbidden"
}{
"detail": "string",
"message": "string",
"type": "not_found"
}{
"detail": "string",
"message": "string",
"type": "too_many_requests",
"retry_after": 0
}{
"detail": "string",
"message": "string",
"type": "internal_error",
"reference_id": "string"
}{
"detail": "string",
"message": "string",
"type": "service_unavailable"
}