Contacts

Retrieve all contacts using cursor-based pagination. The results are sorted by contact last modification date in descending order, with a page size of 25 items.

get/contacts

Request

  • Base URL: https://api.charla.com/v1
  • URL: https://api.charla.com/v1/contacts
  • Auth: API key in header X-Api-Key

Query parameters

cursorinteger

A pagination cursor returned by a previous request (Optional).
Omit this parameter to start from the beginning.
Pass the value from the last item of a previous response to fetch the next page.

Response

OK

Example response

{
  "data": [
    {
      "id": "a9b259f5-3c3c-471e-86c7-3e69b3d83d25",
      "name": "Adam",
      "phone": "+201223461740",
      "email": "hello@site.com",
      "country_code": "US",
      "location": "Miami, Florida",
      "ip": "82.48.123.43",
      "platform": "iPhone, iOS",
      "browser_language": "en-US",
      "tags": "lead, hot",
      "custom_attributes": [
        {
          "name": "Company",
          "value": "Charla",
          "external_id": "company-39415"
        }
      ],
      "messages": [
        {
          "message": "Hello there",
          "message_translated": "Hola",
          "from": "Visitor",
          "article": 5
        }
      ]
    }
  ],
  "paging": {
    "total": 25,
    "next_cursor": 1757765348,
    "has_next": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.