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

Search contacts

Finds contacts that match a filter on standard fields, custom properties, or additional fields. Results are sorted by most recently updated.

Call GET /api/crm/contact/filter-fields first: it lists every field you can filter on, with its field_category, id, type, and allowed operations. Leave out filter to list all contacts.

post
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.

Body
pageinteger · min: 1OptionalDefault: 1
limitinteger · min: 1 · max: 200OptionalDefault: 200
Responses
200

Matching contacts.

application/json
messagestringOptional
post/api/crm/contact/search
POST /api/crm/contact/search HTTP/1.1
Host: api.cekat.ai
api_key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 269

{
  "page": 1,
  "limit": 50,
  "filter": {
    "condition": "AND",
    "criteria": [
      {
        "field_category": "primary",
        "field_id": "email",
        "operator": "contains",
        "value": "@example.com"
      },
      {
        "field_category": "crm_column",
        "field_id": "7a6b5c4d-3e2f-4a1b-8c9d-0e1f2a3b4c5d",
        "operator": "is",
        "value": "Gold"
      }
    ]
  }
}
{
  "message": "success",
  "data": {
    "contacts": [
      {
        "id": "5c6d7e8f-9a0b-4c1d-2e3f-4a5b6c7d8e9f",
        "display_name": "Jane Doe",
        "phone_number": "6281234567890",
        "email": "[email protected]",
        "crm_column": {
          "Customer tier": "Gold"
        }
      }
    ],
    "filter": {
      "condition": "AND",
      "criteria": [
        {
          "field_category": "primary",
          "field_id": "email",
          "operator": "contains",
          "value": "@example.com"
        }
      ]
    },
    "pagination": {
      "page": 1,
      "limit": 50,
      "total_items": 1,
      "total_pages": 1,
      "has_next_page": false,
      "has_previous_page": false
    }
  }
}

Last updated