Rev users

Scan Rev Users (POST)

Scans through all Rev users.

POST
/rev-users.scan

Authorization

AuthorizationBearer <token>

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

Request Body

associations?array<string>

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

created_by?array<string>

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

created_date?date-time-filter
cursor?string

The cursor to resume iteration, otherwise the beginning if not provided.

Formattext
custom_fields?object

Filters for custom fields.

Empty Object

email?array<string>

List of emails of Rev users to be filtered.

external_ref?array<string>

List of external refs to filter Rev users for.

external_refs?array<string>

Filters for Rev users with the provided external_refs.

is_verified?boolean

Value of is_verified field to filter the Rev users.

modified_date?date-time-filter
phone_numbers?array<string>

List of phone numbers, in E.164 format, to filter Rev users on.

rev_org?array<string>

List of IDs of Rev organizations to be filtered.

tags?array<string>

List of tags to be filtered.

Response Body

curl -X POST "https://api.devrev.ai/rev-users.scan" \  -H "Content-Type: application/json" \  -d '{}'
{
  "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",
      "artifacts": [
        {
          "display_id": "string",
          "id": "string",
          "file": {
            "type": "string",
            "name": "string",
            "size": 0
          }
        }
      ],
      "custom_fields": {},
      "custom_schema_fragments": [
        "don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id"
      ],
      "description": "string",
      "external_ref": "string",
      "external_refs": [
        "string"
      ],
      "is_verified": true,
      "rev_org": {
        "type": "account",
        "display_id": "string",
        "id": "string",
        "display_name": "string"
      },
      "stock_schema_fragment": "don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id",
      "subtype": "string",
      "tags": [
        {
          "tag": {
            "display_id": "string",
            "id": "string",
            "name": "string",
            "style_new": {
              "color": "string"
            }
          },
          "value": "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"
}