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

List agents (v2)

Lists agents with search, sorting, and Chat or CRM access filters. With module=chat, each agent includes their Chat role, divisions and inboxes; otherwise their CRM access.

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
searchstringOptional

Matches name or email.

modulestring · enumOptional

Only agents with access to this module.

Possible values:
is_active_otherstringOptional

With module=chat, send crm to exclude agents who also have CRM access; with module=crm, send chat to exclude agents who also have Chat access.

sort_bystring · enumOptionalDefault: created_atPossible values:
sort_orderstring · enumOptionalDefault: descPossible values:
pageinteger · min: 1OptionalDefault: 1
limitinteger · min: 1 · max: 100OptionalDefault: 20
Responses
200

A page of agents.

application/json
successbooleanOptional
get/api/agents/v2
GET /api/agents/v2 HTTP/1.1
Host: api.cekat.ai
api_key: YOUR_API_KEY
Accept: */*
{
  "success": true,
  "data": [
    {
      "id": "1b2c3d4e-5f6a-4b7c-8d9e-0f1a2b3c4d5e",
      "name": "Admin Toko",
      "email": "[email protected]",
      "is_verified": true,
      "chat": {
        "role": "super_agent",
        "is_active": true,
        "divisions": [],
        "inboxes": []
      }
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1,
    "total_pages": 1
  }
}

Last updated