Skip to main content
GET
Retrieve a conversation

Authorizations

Authorization
string
header
required

A workspace API token. Create one in Settings → API. Send it as Authorization: Bearer sk_live_....

Path Parameters

conversation_id
string
required

Unique identifier for a conversation.

Pattern: ^conv_[0-9a-f]{32}$
Example:

"conv_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"

Response

Successful Response

One thread with one contact on one channel.

created_at
string<date-time>
required
id
string
required

Also the session id, which is what identifies a thread.

Pattern: ^conv_[0-9a-f]{32}$
Example:

"conv_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"

updated_at
string<date-time>
required
channel
string | null

Platform this thread runs on, e.g. whatsapp.

contact_id
string | null

Unique identifier for a contact.

Pattern: ^con_[0-9a-f]{32}$
Example:

"con_9f2ac41d8b7e4a51b0d3e6f7a1c2d3e4"

last_message_at
string<date-time> | null
needs_human
boolean | null

Whether the agent has asked for a person to take over.

object
string
default:conversation
Allowed value: "conversation"
queue_name
string | null

The queue currently handling it, if any.

status
string | null

Status of the open task, when one is open — otherwise null.