One conversation with its transcript (capped at 500 messages; truncated is true when longer). Returns 404 when the conversation does not exist or belongs to an agent this key cannot access. Requires the read:conversations permission.
Authorization
BearerAuth read:conversationsIn: header
Scope: read:conversations
Path Parameters
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/v1/conversations/string"{
"conversation": {
"id": "sess_9f8e7d",
"agentId": "a1b2c3d4e5",
"channel": "widget",
"firstMessage": "Where is my order?",
"messageCount": 6,
"visitorName": "Ada Lovelace",
"visitorEmail": "[email protected]",
"visitorPhone": null,
"tags": [
"vip"
],
"handoffStatus": "ai",
"rating": 4,
"startedAt": "2026-08-01T10:00:00.000Z",
"lastMessageAt": "2026-08-01T10:05:00.000Z",
"endedAt": null
},
"messages": [
{
"id": 421,
"role": "user",
"content": "Where is my order?",
"createdAt": "2026-08-01T10:00:04.000Z"
}
],
"truncated": true
}{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"issues": [
{
"path": "string",
"message": "string"
}
]
}{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"issues": [
{
"path": "string",
"message": "string"
}
]
}{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"issues": [
{
"path": "string",
"message": "string"
}
]
}{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"issues": [
{
"path": "string",
"message": "string"
}
]
}{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"issues": [
{
"path": "string",
"message": "string"
}
]
}{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"issues": [
{
"path": "string",
"message": "string"
}
]
}List conversations GET
List conversations for an agent, newest first, paged with `limit`/`offset` and filterable by `channel` or `state`. Includes visitor contact details the agent captured, never network or location data. Requires the `read:conversations` permission.
Get account usage GET
Plan, message credits used against the monthly allowance, subscription status, and days until the period resets. Requires the `read:usage` permission.