Threads
Inspect conversation threads scoped to a specific inbox.
Threads group inbound and outbound messages that share a conversation context. Each thread contains ordered messages for an inbox.
List threads
- Method:
GET - Path:
/v1/inboxes/{inboxId}/threads - Auth: Required
Path parameters
| Parameter | Type | Description |
|---|---|---|
inboxId | string | Inbox that owns the threads. |
Response 200 OK
[
{
"id": "thread_01J3ZQ12ES2WYX3X6J1S3MW8H2",
"subject": "Question about pricing",
"messages": [
{
"id": "msg_01J3ZN9SB2M5MHF5C2QBP4DT78",
"subject": "Question about pricing",
"text": "Can you share your enterprise plan details?",
"html": "<p>Can you share your enterprise plan details?</p>",
"labels": ["inbound"],
"createdAt": "2024-10-10T19:22:10Z"
}
]
}
]
Threads include a subset of message fields optimized for quick drill-down in dashboards. Fetch the full message record if you need complete metadata or MIME parts.
Retrieve a thread
- Method:
GET - Path:
/v1/inboxes/{inboxId}/threads/{threadId} - Auth: Required
Path parameters
| Parameter | Type | Description |
|---|---|---|
inboxId | string | Inbox that owns the thread. |
threadId | string | Identifier for the thread to retrieve. |
Response 200 OK
{
"id": "thread_01J3ZQ12ES2WYX3X6J1S3MW8H2",
"subject": "Question about pricing",
"messages": [
{
"id": "msg_01J3ZN9SB2M5MHF5C2QBP4DT78",
"subject": "Question about pricing",
"text": "Can you share your enterprise plan details?",
"html": "<p>Can you share your enterprise plan details?</p>",
"labels": ["inbound"],
"createdAt": "2024-10-10T19:22:10Z"
}
// ...additional messages ordered newest→oldest
]
}
Each message entry follows the Message schema. Use thread data to build conversational UIs or to correlate agent replies with inbound context.