For the complete documentation index, see llms.txt. This page is also available as Markdown.

List contacts

Lists your contacts, newest first, with the inboxes they have talked to you through. Only contacts with at least one conversation in an active inbox are included. Use POST /api/crm/contact/search to filter by fields or custom properties.

get
Authorizations
api_keystringRequired

Your business's Cekat API key, from Settings → Developers & API in the Cekat dashboard (https://chat.cekat.ai/developers?section=apikeys). Available on the Business and Enterprise plans.

Query parameters
pageinteger · min: 1OptionalDefault: 1
limitinteger · min: 1OptionalDefault: 10
start_datestring · dateOptional

Only include items created on or after this date (YYYY-MM-DD). Cannot be combined with start_datetime.

Example: 2026-10-01
end_datestring · dateOptional

Only include items created on or before the end of this date (YYYY-MM-DD). Cannot be combined with end_datetime.

Example: 2026-10-31
start_datetimestringOptional

Only include items created at or after this time (YYYY-MM-DDTHH:mm:ss, optional offset such as +07:00 or Z). Cannot be combined with start_date.

Example: 2026-10-01T08:00:00+07:00
end_datetimestringOptional

Only include items created at or before this time (YYYY-MM-DDTHH:mm:ss, optional offset). Cannot be combined with end_date.

Example: 2026-10-31T23:59:59+07:00
Header parameters
X-User-TimezonestringOptional

IANA time zone used to read date filters that have no offset. Defaults to Asia/Jakarta.

Example: Asia/Jakarta
Responses
200

A page of contacts.

application/json
successbooleanOptional
get/api/contacts
GET /api/contacts HTTP/1.1
Host: api.cekat.ai
api_key: YOUR_API_KEY
Accept: */*
{
  "success": true,
  "data": [
    {
      "id": "5c6d7e8f-9a0b-4c1d-2e3f-4a5b6c7d8e9f",
      "contact_name": "Jane Doe",
      "email": "[email protected]",
      "phone_number": "6281234567890",
      "platform_id": "6281234567890",
      "username": null,
      "platform": "whatsapp",
      "created_at": "2026-10-01T04:12:30.000000+00:00",
      "additional_data": {
        "city": "Jakarta"
      },
      "inboxes": [
        {
          "id": "0f9e8d7c-6b5a-4c3d-2e1f-0a9b8c7d6e5f",
          "name": "Toko Utama"
        }
      ]
    }
  ],
  "metadata": {
    "pagination": {
      "current_page": 1,
      "total_page": 12,
      "total_items": 115
    }
  }
}

Last updated