API ReferenceConversations

List conversations

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

Authorization

ApiKeyAuth
AuthorizationBearer <token>

Team API key (prefix sk_). Use Authorization: Bearer or X-Api-Key: .

In: header

Path Parameters

agentId*string

Query Parameters

page?integer
limit?integer
search?string
channel?string

Response Body

application/json

application/json

curl -X GET "https://example.com/api/v1/console/agents/string/conversations"
{  "message": "Success",  "meta": {    "total_count": 42,    "page_count": 3,    "current_page": 1,    "limit": 20,    "has_next_page": true,    "has_previous_page": true  },  "data": [    {      "id": "string",      "channel_type": "string",      "channel_id": "string",      "is_test_channel": true,      "full_name": "string",      "email": "string",      "phone_number": "string",      "channel_username": "string",      "is_ai_chat_paused": true,      "last_message_at": "2019-08-24T14:15:22Z",      "last_message_preview": "string",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ]}
{  "message": "Resource not found",  "error": "Not Found",  "code": "not_found",  "statusCode": 404,  "request_id": "266ea41d-adf5-480b-af50-15b940c2b846"}

Issue SSE stream ticket

Exchange the API key for a short-lived (~60s), single-use ticket, then open the live message stream at GET .../messages/stream?ticket=<ticket>. Required because EventSource cannot send Authorization headers. The ticket is bound to this agent + conversation and consumed on first use. Requires the conversations:read scope.

List messages

Next Page