Get Conversation By ID
Fetch the message history and details for one conversation.
Headers
x-workspace-idstringrequiredWorkspace identifier for the API.
Path Parameters
conversationIdstringrequiredThe conversation's _id.
Response
_idstringThe conversation's unique identifier.
workspaceIdstringThe workspace the conversation belongs to.
pathwayIdstringThe message flow the conversation belongs to. Absent for an inbound SMS that arrived on a number with no message flow.
agentIdstringThe message flow agent handling the conversation. Absent in the same case as pathwayId.
sessionIdstringInternal session identifier for the conversation.
senderstringThe sender identifier for the conversation, when set.
customerobjectThe customer in the conversation.
messagesarrayThe messages in the conversation, oldest first.
statusstringopen or completed.
completedAtstringWhen the conversation was completed, if it has been.
lastActivitystringWhen the conversation last had activity, when tracked.
createdAtstringWhen the conversation was created.
updatedAtstringWhen the conversation was last updated.
Errors
| Status | Body | When |
|---|---|---|
400 | {"error": "Workspace ID is required"} | No x-workspace-id |
500 | {"error": "..."} | Unexpected server error |
{
"_id": "b9b9b9b9b9b9b9b9b9b9b9b9",
"workspaceId": "b4b4b4b4b4b4b4b4b4b4b4b4",
"pathwayId": "b7b7b7b7b7b7b7b7b7b7b7b7",
"agentId": "b6b6b6b6b6b6b6b6b6b6b6b6",
"sessionId": "b6b6b6b6b6b6b6b6b6b6b6b6:+14155550123",
"customer": {
"name": "Sam",
"email": "Unknown",
"phone": "+14155550123"
},
"messages": [
{
"_id": "b8b8b8b8b8b8b8b8b8b8b8b8",
"direction": "outbound",
"sent": true,
"message": "Hi Sam, your appointment is confirmed for tomorrow at 3 PM.",
"status": "auto-approved",
"additional_kwargs": {},
"createdAt": "2026-10-01T08:45:00.000Z",
"updatedAt": "2026-10-01T08:45:00.000Z"
},
{
"_id": "c0c0c0c0c0c0c0c0c0c0c0c0",
"direction": "inbound",
"sent": true,
"message": "Thanks, see you then!",
"status": "received",
"additional_kwargs": {},
"createdAt": "2026-10-01T08:55:00.000Z",
"updatedAt": "2026-10-01T08:55:00.000Z"
}
],
"status": "open",
"createdAt": "2026-10-01T08:45:00.000Z",
"updatedAt": "2026-10-01T08:55:00.000Z"
}Last updated on