Skip to main content
GET
/
v2
/
contacts
cURL
curl --request GET \
  --url https://api.orq.ai/v2/contacts \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "_id": "contact_01ARZ3NDEKTSV4RRFFQ69G5FAV",
      "external_id": "user_12345",
      "display_name": "Jane Smith",
      "email": "[email protected]",
      "avatar_url": "https://example.com/avatars/jane-smith.jpg",
      "tags": [
        "premium",
        "beta-user"
      ],
      "metadata": {
        "department": "Engineering",
        "role": "Senior Developer"
      },
      "created": "2024-01-15T10:30:00Z",
      "updated": "2024-01-15T10:30:00Z"
    },
    {
      "_id": "contact_01ARZ3NDEKTSV4RRFFQ69G5XY",
      "external_id": "user_67890",
      "display_name": "John Doe",
      "email": "[email protected]",
      "tags": [
        "enterprise"
      ],
      "metadata": {
        "department": "Sales",
        "role": "Account Manager"
      },
      "created": "2024-01-14T09:15:00Z",
      "updated": "2024-01-14T09:15:00Z"
    }
  ],
  "has_more": false
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
limit
number
default:10

A limit on the number of objects to be returned. Limit can range between 1 and 50, and the default is 10

Required range: 1 <= x <= 50
​
starting_after
string

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with 01JJ1HDHN79XAS7A01WB3HYSDB, your subsequent call can include after=01JJ1HDHN79XAS7A01WB3HYSDB in order to fetch the next page of the list.

​
ending_before
string

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, starting with 01JJ1HDHN79XAS7A01WB3HYSDB, your subsequent call can include before=01JJ1HDHN79XAS7A01WB3HYSDB in order to fetch the previous page of the list.

​
search
string

Search contacts by display name or email address. Minimum 2 characters required.

Example:

"john"

​
filter_by
object

Filter contacts by tags. Can be provided as JSON object {"tags": ["premium", "beta-user"]} or as query format "tags=premium,beta-user"

Example:
{ "tags": ["premium", "beta-user"] }
​
include_metrics
boolean | null
default:false

Include usage metrics of the last 30 days for each contact.

Response

200 - application/json

List of contacts

​
object
enum<string>
required
Available options:
list
​
data
object[]
required
​
has_more
boolean
required