List contacts

GET/v1/contacts

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Query parameters

searchstring

Search by name, email, phone, first_name, or last_name

limitinteger<int32>

Results per page

min 1 · max 100 · default: 20

offsetinteger<int32>

Offset for pagination

min 0 · default: 0

sortstring

Sort contacts by newest or name

default: "newest"

Allowed:newestname

Responses

200OK

itemsContactItem[] | nullrequired

Show properties

Array of ContactItem

acquisition_campaignstring | nullrequired

acquisition_mediumstring | nullrequired

acquisition_sourcestring | nullrequired

average_order_valuestring | nullrequired

created_atstringrequired

custom_fieldsanyrequired

emailstring | nullrequired

engagement_scoreinteger<int32> | nullrequired

external_idstring | nullrequired

external_sourcestring | nullrequired

first_conversation_atstring | nullrequired

first_message_atstring | nullrequired

first_namestring | nullrequired

first_purchase_atstring | nullrequired

first_response_atstring | nullrequired

first_seen_atstring | nullrequired

idstringrequired

last_activity_atstring | nullrequired

last_inbound_message_atstring | nullrequired

last_namestring | nullrequired

last_outbound_message_atstring | nullrequired

last_purchase_atstring | nullrequired

lifecycle_stage_changed_atstring | nullrequired

lifecycle_stage_idstring | nullrequired

lifetime_valuestring | nullrequired

metadataanyrequired

namestring | nullrequired

organization_idstringrequired

phone_numberstring | nullrequired

profile_pic_urlstring | nullrequired

rfm_frequencyinteger<int32> | nullrequired

rfm_monetaryinteger<int32> | nullrequired

rfm_recencyinteger<int32> | nullrequired

rfm_scorestring | nullrequired

rfm_segmentstring | nullrequired

total_ordersinteger<int32> | nullrequired

updated_atstringrequired

metaPaginationMetarequired

Show properties

cursorstring

has_morebooleanrequired

limitinteger<int64>required

next_cursorstring

offsetinteger<int64>

totalinteger<int64>

400Bad Request

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

401Unauthorized

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

403Forbidden

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

422Unprocessable Entity

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

500Internal Server Error

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X GET "/v1/contacts"

const response = await fetch("/v1/contacts", {
  method: "GET"
});

import requests

response = requests.get(
    "/v1/contacts",
)

Response

{
  "items": [
    {
      "acquisition_campaign": "string",
      "acquisition_medium": "string",
      "acquisition_source": "string",
      "average_order_value": "string",
      "created_at": "string",
      "custom_fields": "string",
      "email": "string",
      "engagement_score": 0,
      "external_id": "string",
      "external_source": "string",
      "first_conversation_at": "string",
      "first_message_at": "string",
      "first_name": "string",
      "first_purchase_at": "string",
      "first_response_at": "string",
      "first_seen_at": "string",
      "id": "string",
      "last_activity_at": "string",
      "last_inbound_message_at": "string",
      "last_name": "string",
      "last_outbound_message_at": "string",
      "last_purchase_at": "string",
      "lifecycle_stage_changed_at": "string",
      "lifecycle_stage_id": "string",
      "lifetime_value": "string",
      "metadata": "string",
      "name": "string",
      "organization_id": "string",
      "phone_number": "string",
      "profile_pic_url": "string",
      "rfm_frequency": 0,
      "rfm_monetary": 0,
      "rfm_recency": 0,
      "rfm_score": "string",
      "rfm_segment": "string",
      "total_orders": 0,
      "updated_at": "string"
    }
  ],
  "meta": {
    "cursor": "string",
    "has_more": true,
    "limit": 0,
    "next_cursor": "string",
    "offset": 0,
    "total": 0
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}