API ReferenceConversations

List conversations

List conversations for an agent. Filter with channel, is_test_channel, is_ai_chat_paused, needs_attention, and search. Rate limit: 120 requests/minute per API key.

GET
/api/v1/console/agents/{agentId}/conversations

Authorization

ApiKeyAuth
AuthorizationBearer <token>

Team API key (prefix sk_). You may also send the key via X-Api-Key header.

In: header

Path Parameters

agentId*string

Query Parameters

page?number

Page number (1-based)

limit?number

Items per page (max 100)

search?string

Free-text search filter

sort?string

Sort field with optional leading "-" for descending (e.g. "-created_at").

channel?string

Filter by channel type (live or test_* variants).

is_test_channel?boolean

Filter test-channel conversations

is_ai_chat_paused?boolean

Filter by AI pause state

needs_attention?boolean

Filter conversations needing attention

Response Body

application/json

curl -X GET "https://example.com/api/v1/console/agents/string/conversations"
{  "message": "Success",  "meta": {    "total_count": 0,    "page_count": 0,    "current_page": 0,    "limit": 0,    "has_next_page": true,    "has_previous_page": true  },  "data": [    {      "id": "string",      "channel_type": "string",      "channel_id": "string",      "channel_user_id": "string",      "channel_user_username": "string",      "is_test_channel": true,      "is_ai_chat_paused": true,      "needs_attention": true,      "last_message_at": "2019-08-24T14:15:22Z",      "last_seen": "2019-08-24T14:15:22Z",      "last_message_preview": "string",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ]}