Inboxes API
Query inbox (channel) information with extended filtering capabilities.
List Inboxes
GET/api/inboxes
Retrieve all inboxes with their configuration and statistics.
Query Parameters
pageinteger
Page number (default: 1)
limitinteger
Results per page (default: 10)
bash
curl -X GET "https://api.cekat.ai/api/inboxes" \
-H "Authorization: Bearer YOUR_API_KEY"
Response
200 OK
{
"success": true,
"data": [
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "CekatAI Verified",
"type": "whatsapp",
"status": "active",
"flow_id": null,
"flow_mode": false,
"flow_name": null,
"ai_agent_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"ai_agent_name": "Clara AI",
"auto_reassign": false,
"phone_number": "6287751700285",
"business_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"created_at": "2025-08-07T20:49:30.831195+00:00"
},
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "Live Chat Support",
"type": "livechat",
"status": "active",
"flow_id": null,
"flow_mode": false,
"ai_agent_id": null,
"ai_agent_name": null,
"auto_reassign": false,
"phone_number": null,
"business_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"created_at": "2025-09-14T18:36:18.029437+00:00"
}
],
"metadata": {
"pagination": {
"total_page": 8,
"total_items": 15,
"current_page": 1
}
}
}
Inbox Object
| Field | Type | Description |
|---|---|---|
id | string (UUID) | Unique inbox identifier |
name | string | Display name |
type | string | Channel type: whatsapp, livechat, messenger, instagram |
status | string | Current status: active, inactive |
phone_number | string | Phone number (WhatsApp only) |
ai_agent_id | string | AI agent ID if assigned |
ai_agent_name | string | AI agent display name |
flow_id | string | Flow ID if automation is enabled |
flow_mode | boolean | Whether flow mode is active |
flow_name | string | Flow display name |
auto_reassign | boolean | Auto-assign to available agents |
business_id | string | Business account ID |
created_at | string | Creation timestamp (ISO 8601) |
Inbox Types
| Type | Description |
|---|---|
whatsapp | WhatsApp Business API inbox |
livechat | Website live chat widget |
messenger | Facebook Messenger |
instagram | Instagram Direct Messages |
Code Examples
javascript
const getInboxes = async () => {
const response = await fetch('https://api.cekat.ai/api/inboxes', {
headers: { 'Authorization': 'Bearer YOUR_API_KEY' }
});
return response.json();
};
const inboxes = await getInboxes();
// Filter WhatsApp inboxes
const whatsappInboxes = inboxes.data.filter(
inbox => inbox.type === 'whatsapp' && inbox.status === 'active'
);
console.log(`Found ${whatsappInboxes.length} active WhatsApp inboxes`);