# New Open API

Extended API endpoints for CRM, Orders, Campaigns, Conversations, Contacts, and Agents.

## boards

> List all CRM boards available in your workspace.

```json
{"openapi":"3.0.3","info":{"title":"Cekat Open API","version":"1.0.0"},"tags":[{"name":"New Open API","description":"Extended API endpoints for CRM, Orders, Campaigns, Conversations, Contacts, and Agents."}],"servers":[{"url":"https://api.cekat.ai","description":"Production server"},{"url":"http://localhost:3000","description":"Local development server"}],"security":[{"CekatApiKey":[]}],"components":{"securitySchemes":{"CekatApiKey":{"type":"apiKey","in":"header","name":"api_key","description":"Your Cekat API key. Obtain this by calling `POST /register` or from your Cekat dashboard under Settings → API."}}},"paths":{"/api/crm/boards":{"get":{"summary":"boards","tags":["New Open API"],"operationId":"New_Open_API_CRM_Open_API_Copy_boards","description":"List all CRM boards available in your workspace.","responses":{"200":{"description":"Successful response"},"400":{"description":"Bad request — check required fields and formats."},"401":{"description":"Unauthorized — API key is missing or invalid."},"404":{"description":"Resource not found."}}}}}}
```

## board

> Retrieve detailed information about a specific CRM board.

```json
{"openapi":"3.0.3","info":{"title":"Cekat Open API","version":"1.0.0"},"tags":[{"name":"New Open API","description":"Extended API endpoints for CRM, Orders, Campaigns, Conversations, Contacts, and Agents."}],"servers":[{"url":"https://api.cekat.ai","description":"Production server"},{"url":"http://localhost:3000","description":"Local development server"}],"security":[{"CekatApiKey":[]}],"components":{"securitySchemes":{"CekatApiKey":{"type":"apiKey","in":"header","name":"api_key","description":"Your Cekat API key. Obtain this by calling `POST /register` or from your Cekat dashboard under Settings → API."}}},"paths":{"/api/crm/boards/{id}":{"get":{"summary":"board","tags":["New Open API"],"operationId":"New_Open_API_CRM_Open_API_Copy_board","description":"Retrieve detailed information about a specific CRM board.","parameters":[{"name":"id","in":"path","required":true,"description":"UUID of the resource.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"},"400":{"description":"Bad request — check required fields and formats."},"401":{"description":"Unauthorized — API key is missing or invalid."},"404":{"description":"Resource not found."}}}}}}
```

## column

> Retrieve details of a specific column within a CRM board.

```json
{"openapi":"3.0.3","info":{"title":"Cekat Open API","version":"1.0.0"},"tags":[{"name":"New Open API","description":"Extended API endpoints for CRM, Orders, Campaigns, Conversations, Contacts, and Agents."}],"servers":[{"url":"https://api.cekat.ai","description":"Production server"},{"url":"http://localhost:3000","description":"Local development server"}],"security":[{"CekatApiKey":[]}],"components":{"securitySchemes":{"CekatApiKey":{"type":"apiKey","in":"header","name":"api_key","description":"Your Cekat API key. Obtain this by calling `POST /register` or from your Cekat dashboard under Settings → API."}}},"paths":{"/api/crm/boards/{boardId}/columns/{columnId}":{"get":{"summary":"column","tags":["New Open API"],"operationId":"New_Open_API_CRM_Open_API_Copy_column","description":"Retrieve details of a specific column within a CRM board.","parameters":[{"name":"boardId","in":"path","required":true,"description":"UUID of the CRM board. Retrieve available boards via `GET /api/crm/boards`.","schema":{"type":"string"}},{"name":"columnId","in":"path","required":true,"description":"UUID of the column within a board.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"},"400":{"description":"Bad request — check required fields and formats."},"401":{"description":"Unauthorized — API key is missing or invalid."},"404":{"description":"Resource not found."}}}}}}
```

## column by name

> Look up a column within a CRM board by its name instead of UUID.

```json
{"openapi":"3.0.3","info":{"title":"Cekat Open API","version":"1.0.0"},"tags":[{"name":"New Open API","description":"Extended API endpoints for CRM, Orders, Campaigns, Conversations, Contacts, and Agents."}],"servers":[{"url":"https://api.cekat.ai","description":"Production server"},{"url":"http://localhost:3000","description":"Local development server"}],"security":[{"CekatApiKey":[]}],"components":{"securitySchemes":{"CekatApiKey":{"type":"apiKey","in":"header","name":"api_key","description":"Your Cekat API key. Obtain this by calling `POST /register` or from your Cekat dashboard under Settings → API."}}},"paths":{"/api/crm/boards/{boardId}/columns/by-name":{"post":{"summary":"column by name","tags":["New Open API"],"operationId":"New_Open_API_CRM_Open_API_Copy_column_by_name","description":"Look up a column within a CRM board by its name instead of UUID.","parameters":[{"name":"boardId","in":"path","required":true,"description":"UUID of the CRM board. Retrieve available boards via `GET /api/crm/boards`.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Unique snake_case name for the template, e.g. `promo_ramadan`. Must match Meta's naming rules (lowercase, no spaces)."}}}}}},"responses":{"200":{"description":"Successful response"},"400":{"description":"Bad request — check required fields and formats."},"401":{"description":"Unauthorized — API key is missing or invalid."},"404":{"description":"Resource not found."}}}}}}
```

## items

> List all items (cards/leads) within a CRM board.

```json
{"openapi":"3.0.3","info":{"title":"Cekat Open API","version":"1.0.0"},"tags":[{"name":"New Open API","description":"Extended API endpoints for CRM, Orders, Campaigns, Conversations, Contacts, and Agents."}],"servers":[{"url":"https://api.cekat.ai","description":"Production server"},{"url":"http://localhost:3000","description":"Local development server"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{}},"paths":{"/api/crm/boards/{boardId}/items":{"get":{"summary":"items","tags":["New Open API"],"operationId":"New_Open_API_CRM_Open_API_Copy_items","description":"List all items (cards/leads) within a CRM board.","parameters":[{"name":"boardId","in":"path","required":true,"description":"UUID of the CRM board. Retrieve available boards via `GET /api/crm/boards`.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"},"400":{"description":"Bad request — check required fields and formats."},"401":{"description":"Unauthorized — API key is missing or invalid."},"404":{"description":"Resource not found."}}}}}}
```

## item with values

> Create a new item (lead/contact card) in a CRM board.

```json
{"openapi":"3.0.3","info":{"title":"Cekat Open API","version":"1.0.0"},"tags":[{"name":"New Open API","description":"Extended API endpoints for CRM, Orders, Campaigns, Conversations, Contacts, and Agents."}],"servers":[{"url":"https://api.cekat.ai","description":"Production server"},{"url":"http://localhost:3000","description":"Local development server"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{}},"paths":{"/api/crm/boards/{boardId}/items":{"post":{"summary":"item with values","tags":["New Open API"],"operationId":"New_Open_API_CRM_Open_API_Copy_item_with_values","description":"Create a new item (lead/contact card) in a CRM board.","parameters":[{"name":"boardId","in":"path","required":true,"description":"UUID of the CRM board. Retrieve available boards via `GET /api/crm/boards`.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"item_name":{"type":"string","description":"The item name value."},"New Text":{"type":"string","description":"The New Text value."},"New Agents":{"type":"array","items":{"type":"string"},"description":"The New Agents value."}}}}}},"responses":{"200":{"description":"Successful response"},"400":{"description":"Bad request — check required fields and formats."},"401":{"description":"Unauthorized — API key is missing or invalid."},"404":{"description":"Resource not found."}}}}}}
```

## items

> Delete one or more items from a CRM board.

```json
{"openapi":"3.0.3","info":{"title":"Cekat Open API","version":"1.0.0"},"tags":[{"name":"New Open API","description":"Extended API endpoints for CRM, Orders, Campaigns, Conversations, Contacts, and Agents."}],"servers":[{"url":"https://api.cekat.ai","description":"Production server"},{"url":"http://localhost:3000","description":"Local development server"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{}},"paths":{"/api/crm/boards/{boardId}/items":{"delete":{"summary":"items","tags":["New Open API"],"operationId":"New_Open_API_CRM_Open_API_Copy_items_2","description":"Delete one or more items from a CRM board.","parameters":[{"name":"boardId","in":"path","required":true,"description":"UUID of the CRM board. Retrieve available boards via `GET /api/crm/boards`.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"item_ids":{"type":"array","items":{"type":"string"},"description":"The item ids value."}}}}}},"responses":{"200":{"description":"Successful response"},"400":{"description":"Bad request — check required fields and formats."},"401":{"description":"Unauthorized — API key is missing or invalid."},"404":{"description":"Resource not found."}}}}}}
```

## item

> Retrieve full details of a specific CRM item, including contact info, conversation data, and pipeline status.

```json
{"openapi":"3.0.3","info":{"title":"Cekat Open API","version":"1.0.0"},"tags":[{"name":"New Open API","description":"Extended API endpoints for CRM, Orders, Campaigns, Conversations, Contacts, and Agents."}],"servers":[{"url":"https://api.cekat.ai","description":"Production server"},{"url":"http://localhost:3000","description":"Local development server"}],"security":[{"CekatApiKey":[]}],"components":{"securitySchemes":{"CekatApiKey":{"type":"apiKey","in":"header","name":"api_key","description":"Your Cekat API key. Obtain this by calling `POST /register` or from your Cekat dashboard under Settings → API."}}},"paths":{"/api/crm/boards/{boardId}/items/{id}":{"get":{"summary":"item","tags":["New Open API"],"operationId":"New_Open_API_CRM_Open_API_Copy_item","description":"Retrieve full details of a specific CRM item, including contact info, conversation data, and pipeline status.","parameters":[{"name":"boardId","in":"path","required":true,"description":"UUID of the CRM board. Retrieve available boards via `GET /api/crm/boards`.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"UUID of the resource.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"},"400":{"description":"Bad request — check required fields and formats."},"401":{"description":"Unauthorized — API key is missing or invalid."},"404":{"description":"Resource not found."}}}}}}
```

## items search

> Search for items within a CRM board using filters.

```json
{"openapi":"3.0.3","info":{"title":"Cekat Open API","version":"1.0.0"},"tags":[{"name":"New Open API","description":"Extended API endpoints for CRM, Orders, Campaigns, Conversations, Contacts, and Agents."}],"servers":[{"url":"https://api.cekat.ai","description":"Production server"},{"url":"http://localhost:3000","description":"Local development server"}],"security":[{"CekatApiKey":[]}],"components":{"securitySchemes":{"CekatApiKey":{"type":"apiKey","in":"header","name":"api_key","description":"Your Cekat API key. Obtain this by calling `POST /register` or from your Cekat dashboard under Settings → API."}}},"paths":{"/api/crm/boards/{boardId}/items/search":{"post":{"summary":"items search","tags":["New Open API"],"operationId":"New_Open_API_CRM_Open_API_Copy_items_search","description":"Search for items within a CRM board using filters.","parameters":[{"name":"boardId","in":"path","required":true,"description":"UUID of the CRM board. Retrieve available boards via `GET /api/crm/boards`.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"condition":{"type":"string","description":"The condition value."},"search":{"type":"array","items":{"type":"object","properties":{"column_name":{"type":"string"},"operator":{"type":"string"},"value":{"type":"array","items":{"type":"string"}}}},"description":"The search value."}}}}}},"responses":{"200":{"description":"Successful response"},"400":{"description":"Bad request — check required fields and formats."},"401":{"description":"Unauthorized — API key is missing or invalid."},"404":{"description":"Resource not found."}}}}}}
```

## item with values

> Update fields of an existing CRM item.

```json
{"openapi":"3.0.3","info":{"title":"Cekat Open API","version":"1.0.0"},"tags":[{"name":"New Open API","description":"Extended API endpoints for CRM, Orders, Campaigns, Conversations, Contacts, and Agents."}],"servers":[{"url":"https://api.cekat.ai","description":"Production server"},{"url":"http://localhost:3000","description":"Local development server"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{}},"paths":{"/api/crm/boards/{boardId}/items/{itemId}":{"put":{"summary":"item with values","tags":["New Open API"],"operationId":"New_Open_API_CRM_Open_API_Copy_item_with_values_2","description":"Update fields of an existing CRM item.","parameters":[{"name":"boardId","in":"path","required":true,"description":"UUID of the CRM board. Retrieve available boards via `GET /api/crm/boards`.","schema":{"type":"string"}},{"name":"itemId","in":"path","required":true,"description":"UUID of the CRM item to update.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"item_name":{"type":"string","description":"The item name value."},"Title":{"type":"string","description":"The Title value."},"New Agents":{"type":"array","items":{},"description":"The New Agents value."}}}}}},"responses":{"200":{"description":"Successful response"},"400":{"description":"Bad request — check required fields and formats."},"401":{"description":"Unauthorized — API key is missing or invalid."},"404":{"description":"Resource not found."}}}}}}
```

## orders

> Retrieve paginated list of orders.

```json
{"openapi":"3.0.3","info":{"title":"Cekat Open API","version":"1.0.0"},"tags":[{"name":"New Open API","description":"Extended API endpoints for CRM, Orders, Campaigns, Conversations, Contacts, and Agents."}],"servers":[{"url":"https://api.cekat.ai","description":"Production server"},{"url":"http://localhost:3000","description":"Local development server"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{}},"paths":{"/api/orders":{"get":{"summary":"orders","tags":["New Open API"],"operationId":"New_Open_API_Orders_Open_API_Copy_orders_2","description":"Retrieve paginated list of orders.","parameters":[{"name":"order_status","in":"query","required":false,"description":"The order status value.","schema":{"type":"string"}},{"name":"payment_status","in":"query","required":false,"description":"The payment status value.","schema":{"type":"string"}},{"name":"start_date","in":"query","required":false,"description":"Filter start date in `YYYY-MM-DD` format (Jakarta/WIB time, UTC+7).","schema":{"type":"string"}},{"name":"end_date","in":"query","required":false,"description":"Filter end date in `YYYY-MM-DD` format (Jakarta/WIB time, UTC+7).","schema":{"type":"string"}},{"name":"search","in":"query","required":false,"description":"The search value.","schema":{"type":"string"}},{"name":"sort_field","in":"query","required":false,"description":"The sort field value.","schema":{"type":"string"}},{"name":"sort_direction","in":"query","required":false,"description":"The sort direction value.","schema":{"type":"string"}},{"name":"include_conv","in":"query","required":false,"description":"The include conv value.","schema":{"type":"string"}},{"name":"inbox_id","in":"query","required":false,"description":"UUID of the WhatsApp Business inbox this template belongs to. Obtainable via the `GET /inboxes` endpoint.","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number for pagination. Starts at `1`.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"Number of records per page. Default varies by endpoint.","schema":{"type":"string"}},{"name":"product_ids","in":"query","required":false,"description":"The product ids value.","schema":{"type":"string"}},{"name":"export_scope","in":"query","required":false,"description":"The export scope value.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"},"400":{"description":"Bad request — check required fields and formats."},"401":{"description":"Unauthorized — API key is missing or invalid."},"404":{"description":"Resource not found."}}}}}}
```

## orders

> Create a new order record linked to a contact or conversation.

```json
{"openapi":"3.0.3","info":{"title":"Cekat Open API","version":"1.0.0"},"tags":[{"name":"New Open API","description":"Extended API endpoints for CRM, Orders, Campaigns, Conversations, Contacts, and Agents."}],"servers":[{"url":"https://api.cekat.ai","description":"Production server"},{"url":"http://localhost:3000","description":"Local development server"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{}},"paths":{"/api/orders":{"post":{"summary":"orders","tags":["New Open API"],"operationId":"New_Open_API_Orders_Open_API_Copy_orders","description":"Create a new order record linked to a contact or conversation.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"orders_products":{"type":"array","items":{"type":"object","properties":{"product_id":{"type":"string"},"product_name":{"type":"string"},"quantity":{"type":"integer"},"price":{"type":"integer"}}},"description":"The orders products value."},"payment_method":{"type":"string","description":"The payment method value."},"shipping_fee":{"type":"integer","description":"The shipping fee value."},"discount":{"type":"integer","description":"The discount value."},"vat":{"type":"integer","description":"The vat value."},"conversation_id":{"type":"string","description":"UUID of the conversation to retrieve messages from."},"contact_id":{"type":"string","description":"UUID of the contact."},"phone_number":{"type":"string","description":"Business phone number in international format, e.g. `6285695209520`."},"display_name":{"type":"string","description":"The display name value."},"email":{"type":"string","description":"Business email address used for login and notifications."},"notes":{"type":"string","description":"Optional notes or remarks for the order."},"address":{"type":"string","description":"The address value."}}}}}},"responses":{"200":{"description":"Successful response"},"400":{"description":"Bad request — check required fields and formats."},"401":{"description":"Unauthorized — API key is missing or invalid."},"404":{"description":"Resource not found."}}}}}}
```

## order by id

> Retrieve full details of a specific order by its UUID.

```json
{"openapi":"3.0.3","info":{"title":"Cekat Open API","version":"1.0.0"},"tags":[{"name":"New Open API","description":"Extended API endpoints for CRM, Orders, Campaigns, Conversations, Contacts, and Agents."}],"servers":[{"url":"https://api.cekat.ai","description":"Production server"},{"url":"http://localhost:3000","description":"Local development server"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{}},"paths":{"/api/orders/{id}":{"get":{"summary":"order by id","tags":["New Open API"],"operationId":"New_Open_API_Orders_Open_API_Copy_order_by_id","description":"Retrieve full details of a specific order by its UUID.","parameters":[{"name":"id","in":"path","required":true,"description":"UUID of the resource.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"},"400":{"description":"Bad request — check required fields and formats."},"401":{"description":"Unauthorized — API key is missing or invalid."},"404":{"description":"Resource not found."}}}}}}
```

## order

> Update the status or details of an existing order.

```json
{"openapi":"3.0.3","info":{"title":"Cekat Open API","version":"1.0.0"},"tags":[{"name":"New Open API","description":"Extended API endpoints for CRM, Orders, Campaigns, Conversations, Contacts, and Agents."}],"servers":[{"url":"https://api.cekat.ai","description":"Production server"},{"url":"http://localhost:3000","description":"Local development server"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{}},"paths":{"/api/orders/{id}":{"put":{"summary":"order","tags":["New Open API"],"operationId":"New_Open_API_Orders_Open_API_Copy_order","description":"Update the status or details of an existing order.","parameters":[{"name":"id","in":"path","required":true,"description":"UUID of the resource.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"order_status":{"type":"string","description":"The order status value."},"payment_status":{"type":"string","description":"The payment status value."},"custom_invoice_url":{"type":"string","description":"The custom invoice url value."},"invoice_is_sent":{"type":"boolean","description":"The invoice is sent value."},"address":{"type":"string","description":"The address value."},"notes":{"type":"string","description":"Optional notes or remarks for the order."}}}}}},"responses":{"200":{"description":"Successful response"},"400":{"description":"Bad request — check required fields and formats."},"401":{"description":"Unauthorized — API key is missing or invalid."},"404":{"description":"Resource not found."}}}}}}
```

## get messages

> Retrieve paginated messages with optional filters for date range and conversation.

```json
{"openapi":"3.0.3","info":{"title":"Cekat Open API","version":"1.0.0"},"tags":[{"name":"New Open API","description":"Extended API endpoints for CRM, Orders, Campaigns, Conversations, Contacts, and Agents."}],"servers":[{"url":"https://api.cekat.ai","description":"Production server"},{"url":"http://localhost:3000","description":"Local development server"}],"paths":{"/api/messages":{"get":{"summary":"get messages","tags":["New Open API"],"operationId":"New_Open_API_Messages_get_messages","description":"Retrieve paginated messages with optional filters for date range and conversation.","parameters":[{"name":"conversation_id","in":"query","required":false,"description":"UUID of the conversation to retrieve messages from.","schema":{"type":"string"}},{"name":"start_date","in":"query","required":false,"description":"Filter start date in `YYYY-MM-DD` format (Jakarta/WIB time, UTC+7).","schema":{"type":"string"}},{"name":"end_date","in":"query","required":false,"description":"Filter end date in `YYYY-MM-DD` format (Jakarta/WIB time, UTC+7).","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number for pagination. Starts at `1`.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"Number of records per page. Default varies by endpoint.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"},"400":{"description":"Bad request — check required fields and formats."},"401":{"description":"Unauthorized — API key is missing or invalid."},"404":{"description":"Resource not found."}}}}}}
```

## get summary message with chat credit

> Retrieve AI credit usage summary for messages within a specified date range.

```json
{"openapi":"3.0.3","info":{"title":"Cekat Open API","version":"1.0.0"},"tags":[{"name":"New Open API","description":"Extended API endpoints for CRM, Orders, Campaigns, Conversations, Contacts, and Agents."}],"servers":[{"url":"https://api.cekat.ai","description":"Production server"},{"url":"http://localhost:3000","description":"Local development server"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{}},"paths":{"/api/messages/summary/ai_credits":{"get":{"summary":"get summary message with chat credit","tags":["New Open API"],"operationId":"New_Open_API_Messages_get_summary_message_with_chat_credit","description":"Retrieve AI credit usage summary for messages within a specified date range.","parameters":[{"name":"conversation_id","in":"query","required":false,"description":"UUID of the conversation to retrieve messages from.","schema":{"type":"string"}},{"name":"start_date","in":"query","required":false,"description":"Filter start date in `YYYY-MM-DD` format (Jakarta/WIB time, UTC+7).","schema":{"type":"string"}},{"name":"end_date","in":"query","required":false,"description":"Filter end date in `YYYY-MM-DD` format (Jakarta/WIB time, UTC+7).","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"},"400":{"description":"Bad request — check required fields and formats."},"401":{"description":"Unauthorized — API key is missing or invalid."},"404":{"description":"Resource not found."}}}}}}
```

## get agents

> Retrieve all human agents in your Cekat workspace.

```json
{"openapi":"3.0.3","info":{"title":"Cekat Open API","version":"1.0.0"},"tags":[{"name":"New Open API","description":"Extended API endpoints for CRM, Orders, Campaigns, Conversations, Contacts, and Agents."}],"servers":[{"url":"https://api.cekat.ai","description":"Production server"},{"url":"http://localhost:3000","description":"Local development server"}],"security":[{"CekatApiKey":[]}],"components":{"securitySchemes":{"CekatApiKey":{"type":"apiKey","in":"header","name":"api_key","description":"Your Cekat API key. Obtain this by calling `POST /register` or from your Cekat dashboard under Settings → API."}}},"paths":{"/api/agents":{"get":{"summary":"get agents","tags":["New Open API"],"operationId":"New_Open_API_Agents_get_agents","description":"Retrieve all human agents in your Cekat workspace.","parameters":[{"name":"limit","in":"query","required":false,"description":"Number of records per page. Default varies by endpoint.","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number for pagination. Starts at `1`.","schema":{"type":"string"}},{"name":"start_date","in":"query","required":false,"description":"Filter start date in `YYYY-MM-DD` format (Jakarta/WIB time, UTC+7).","schema":{"type":"string"}},{"name":"end_date","in":"query","required":false,"description":"Filter end date in `YYYY-MM-DD` format (Jakarta/WIB time, UTC+7).","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"},"400":{"description":"Bad request — check required fields and formats."},"401":{"description":"Unauthorized — API key is missing or invalid."},"404":{"description":"Resource not found."}}}}}}
```

## get inboxes

> Retrieve paginated list of WhatsApp Business inboxes connected to your account.

```json
{"openapi":"3.0.3","info":{"title":"Cekat Open API","version":"1.0.0"},"tags":[{"name":"New Open API","description":"Extended API endpoints for CRM, Orders, Campaigns, Conversations, Contacts, and Agents."}],"servers":[{"url":"https://api.cekat.ai","description":"Production server"},{"url":"http://localhost:3000","description":"Local development server"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{}},"paths":{"/api/inboxes":{"get":{"summary":"get inboxes","tags":["New Open API"],"operationId":"New_Open_API_Inboxes_get_inboxes","description":"Retrieve paginated list of WhatsApp Business inboxes connected to your account.","parameters":[{"name":"limit","in":"query","required":false,"description":"Number of records per page. Default varies by endpoint.","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number for pagination. Starts at `1`.","schema":{"type":"string"}},{"name":"start_date","in":"query","required":false,"description":"Filter start date in `YYYY-MM-DD` format (Jakarta/WIB time, UTC+7).","schema":{"type":"string"}},{"name":"end_date","in":"query","required":false,"description":"Filter end date in `YYYY-MM-DD` format (Jakarta/WIB time, UTC+7).","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"},"400":{"description":"Bad request — check required fields and formats."},"401":{"description":"Unauthorized — API key is missing or invalid."},"404":{"description":"Resource not found."}}}}}}
```

## get campaigns

> Retrieve paginated list of broadcast campaigns.

```json
{"openapi":"3.0.3","info":{"title":"Cekat Open API","version":"1.0.0"},"tags":[{"name":"New Open API","description":"Extended API endpoints for CRM, Orders, Campaigns, Conversations, Contacts, and Agents."}],"servers":[{"url":"https://api.cekat.ai","description":"Production server"},{"url":"http://localhost:3000","description":"Local development server"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{}},"paths":{"/api/campaigns":{"get":{"summary":"get campaigns","tags":["New Open API"],"operationId":"New_Open_API_Broadcasts_Campaigns_get_campaigns","description":"Retrieve paginated list of broadcast campaigns.","parameters":[{"name":"limit","in":"query","required":false,"description":"Number of records per page. Default varies by endpoint.","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number for pagination. Starts at `1`.","schema":{"type":"string"}},{"name":"start_date","in":"query","required":false,"description":"Filter start date in `YYYY-MM-DD` format (Jakarta/WIB time, UTC+7).","schema":{"type":"string"}},{"name":"end_date","in":"query","required":false,"description":"Filter end date in `YYYY-MM-DD` format (Jakarta/WIB time, UTC+7).","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"},"400":{"description":"Bad request — check required fields and formats."},"401":{"description":"Unauthorized — API key is missing or invalid."},"404":{"description":"Resource not found."}}}}}}
```

## get campaign message

> Retrieve the individual messages sent as part of a specific campaign.

```json
{"openapi":"3.0.3","info":{"title":"Cekat Open API","version":"1.0.0"},"tags":[{"name":"New Open API","description":"Extended API endpoints for CRM, Orders, Campaigns, Conversations, Contacts, and Agents."}],"servers":[{"url":"https://api.cekat.ai","description":"Production server"},{"url":"http://localhost:3000","description":"Local development server"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{}},"paths":{"/api/campaigns/{id}/messages":{"get":{"summary":"get campaign message","tags":["New Open API"],"operationId":"New_Open_API_Broadcasts_Campaigns_get_campaign_message","description":"Retrieve the individual messages sent as part of a specific campaign.","parameters":[{"name":"id","in":"path","required":true,"description":"UUID of the resource.","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number for pagination. Starts at `1`.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"Number of records per page. Default varies by endpoint.","schema":{"type":"string"}},{"name":"start_date","in":"query","required":false,"description":"Filter start date in `YYYY-MM-DD` format (Jakarta/WIB time, UTC+7).","schema":{"type":"string"}},{"name":"end_date","in":"query","required":false,"description":"Filter end date in `YYYY-MM-DD` format (Jakarta/WIB time, UTC+7).","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"},"400":{"description":"Bad request — check required fields and formats."},"401":{"description":"Unauthorized — API key is missing or invalid."},"404":{"description":"Resource not found."}}}}}}
```

## conversation agents assignments

> Retrieve conversation-to-agent assignment records.

```json
{"openapi":"3.0.3","info":{"title":"Cekat Open API","version":"1.0.0"},"tags":[{"name":"New Open API","description":"Extended API endpoints for CRM, Orders, Campaigns, Conversations, Contacts, and Agents."}],"servers":[{"url":"https://api.cekat.ai","description":"Production server"},{"url":"http://localhost:3000","description":"Local development server"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{}},"paths":{"/api/conversations/agent-assignments":{"get":{"summary":"conversation agents assignments","tags":["New Open API"],"operationId":"New_Open_API_Agent_Assignments_conversation_agents_assignments","description":"Retrieve conversation-to-agent assignment records.","parameters":[{"name":"limit","in":"query","required":false,"description":"Number of records per page. Default varies by endpoint.","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number for pagination. Starts at `1`.","schema":{"type":"string"}},{"name":"start_date","in":"query","required":false,"description":"Filter start date in `YYYY-MM-DD` format (Jakarta/WIB time, UTC+7).","schema":{"type":"string"}},{"name":"end_date","in":"query","required":false,"description":"Filter end date in `YYYY-MM-DD` format (Jakarta/WIB time, UTC+7).","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"},"400":{"description":"Bad request — check required fields and formats."},"401":{"description":"Unauthorized — API key is missing or invalid."},"404":{"description":"Resource not found."}}}}}}
```

## get agent assignments

> Retrieve detailed agent assignment history with date range filtering.

```json
{"openapi":"3.0.3","info":{"title":"Cekat Open API","version":"1.0.0"},"tags":[{"name":"New Open API","description":"Extended API endpoints for CRM, Orders, Campaigns, Conversations, Contacts, and Agents."}],"servers":[{"url":"https://api.cekat.ai","description":"Production server"},{"url":"http://localhost:3000","description":"Local development server"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{}},"paths":{"/api/agent_assignments":{"get":{"summary":"get agent assignments","tags":["New Open API"],"operationId":"New_Open_API_Agent_Assignments_get_agent_assignments","description":"Retrieve detailed agent assignment history with date range filtering.","parameters":[{"name":"limit","in":"query","required":false,"description":"Number of records per page. Default varies by endpoint.","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number for pagination. Starts at `1`.","schema":{"type":"string"}},{"name":"start_date","in":"query","required":false,"description":"Filter start date in `YYYY-MM-DD` format (Jakarta/WIB time, UTC+7).","schema":{"type":"string"}},{"name":"end_date","in":"query","required":false,"description":"Filter end date in `YYYY-MM-DD` format (Jakarta/WIB time, UTC+7).","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"},"400":{"description":"Bad request — check required fields and formats."},"401":{"description":"Unauthorized — API key is missing or invalid."},"404":{"description":"Resource not found."}}}}}}
```

## get conversations

> Retrieve paginated list of conversations across all inboxes.

```json
{"openapi":"3.0.3","info":{"title":"Cekat Open API","version":"1.0.0"},"tags":[{"name":"New Open API","description":"Extended API endpoints for CRM, Orders, Campaigns, Conversations, Contacts, and Agents."}],"servers":[{"url":"https://api.cekat.ai","description":"Production server"},{"url":"http://localhost:3000","description":"Local development server"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{}},"paths":{"/api/conversations":{"get":{"summary":"get conversations","tags":["New Open API"],"operationId":"New_Open_API_Conversations_get_conversations","description":"Retrieve paginated list of conversations across all inboxes.","parameters":[{"name":"limit","in":"query","required":false,"description":"Number of records per page. Default varies by endpoint.","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number for pagination. Starts at `1`.","schema":{"type":"string"}},{"name":"start_date","in":"query","required":false,"description":"Filter start date in `YYYY-MM-DD` format (Jakarta/WIB time, UTC+7).","schema":{"type":"string"}},{"name":"end_date","in":"query","required":false,"description":"Filter end date in `YYYY-MM-DD` format (Jakarta/WIB time, UTC+7).","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"},"400":{"description":"Bad request — check required fields and formats."},"401":{"description":"Unauthorized — API key is missing or invalid."},"404":{"description":"Resource not found."}}}}}}
```

## update conversation

> Update conversation properties such as assignee, label, or resolution status.

```json
{"openapi":"3.0.3","info":{"title":"Cekat Open API","version":"1.0.0"},"tags":[{"name":"New Open API","description":"Extended API endpoints for CRM, Orders, Campaigns, Conversations, Contacts, and Agents."}],"servers":[{"url":"https://api.cekat.ai","description":"Production server"},{"url":"http://localhost:3000","description":"Local development server"}],"paths":{"/api/conversations/{id}":{"put":{"summary":"update conversation","tags":["New Open API"],"operationId":"New_Open_API_Conversations_update_conversation","description":"Update conversation properties such as assignee, label, or resolution status.","parameters":[{"name":"id","in":"path","required":true,"description":"UUID of the resource.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"assigned_ai_agent":{"type":"string","description":"The assigned ai agent value."}}}}}},"responses":{"200":{"description":"Successful response"},"400":{"description":"Bad request — check required fields and formats."},"401":{"description":"Unauthorized — API key is missing or invalid."},"404":{"description":"Resource not found."}}}}}}
```

## get contacts

> Retrieve paginated list of contacts in your CRM.

```json
{"openapi":"3.0.3","info":{"title":"Cekat Open API","version":"1.0.0"},"tags":[{"name":"New Open API","description":"Extended API endpoints for CRM, Orders, Campaigns, Conversations, Contacts, and Agents."}],"servers":[{"url":"https://api.cekat.ai","description":"Production server"},{"url":"http://localhost:3000","description":"Local development server"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{}},"paths":{"/api/contacts":{"get":{"summary":"get contacts","tags":["New Open API"],"operationId":"New_Open_API_Contacts_get_contacts","description":"Retrieve paginated list of contacts in your CRM.","parameters":[{"name":"limit","in":"query","required":false,"description":"Number of records per page. Default varies by endpoint.","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number for pagination. Starts at `1`.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"},"400":{"description":"Bad request — check required fields and formats."},"401":{"description":"Unauthorized — API key is missing or invalid."},"404":{"description":"Resource not found."}}}}}}
```

## get templates

> Retrieve paginated list of WhatsApp message templates with optional date filtering.

```json
{"openapi":"3.0.3","info":{"title":"Cekat Open API","version":"1.0.0"},"tags":[{"name":"New Open API","description":"Extended API endpoints for CRM, Orders, Campaigns, Conversations, Contacts, and Agents."}],"servers":[{"url":"https://api.cekat.ai","description":"Production server"},{"url":"http://localhost:3000","description":"Local development server"}],"security":[{"BearerAuth":[]}],"components":{"securitySchemes":{}},"paths":{"/api/templates":{"get":{"summary":"get templates","tags":["New Open API"],"operationId":"New_Open_API_Templates_get_templates","description":"Retrieve paginated list of WhatsApp message templates with optional date filtering.","parameters":[{"name":"page","in":"query","required":false,"description":"Page number for pagination. Starts at `1`.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"Number of records per page. Default varies by endpoint.","schema":{"type":"string"}},{"name":"start_date","in":"query","required":false,"description":"Filter start date in `YYYY-MM-DD` format (Jakarta/WIB time, UTC+7).","schema":{"type":"string"}},{"name":"end_date","in":"query","required":false,"description":"Filter end date in `YYYY-MM-DD` format (Jakarta/WIB time, UTC+7).","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"},"400":{"description":"Bad request — check required fields and formats."},"401":{"description":"Unauthorized — API key is missing or invalid."},"404":{"description":"Resource not found."}}}}}}
```