Skip to main content
GET
Get a conversation

Authorizations

X-API-KEY
string
header
required

Path Parameters

conversation_id
integer
required

The conversation ID.

Required range: x >= 1

Query Parameters

before
string

Pass written.earlier_cursor from the previous response to get the page of messages before it. Omit for the newest messages. The cursor is opaque, so pass it back unchanged. A value that is not a cursor returns 400.

Response

The conversation.

id
integer
Example:

184532

url
string
Example:

"https://answeringagent.com/dashboard/conversations/184532"

channel
Available options:
phone,
text,
web_chat,
email
channels
enum<string>[]

Every channel the conversation happened on. A call the customer replied to by text lists phone and text. Texts the AI sent during or after a call appear in written.messages but don't add text.

Available options:
phone,
text,
web_chat,
email
started_at
string<date-time> | null
last_activity_at
string<date-time> | null
updated_at
string<date-time> | null

When the conversation last changed, in whole seconds. updated_since filters on it. Editing the contact, a phone line, or a team member does not change it.

title
string | null
Example:

"Cancel monthly membership"

summary
string | null
category

A category key. Conversations, tasks, and reports share one list. A form task has form. GET /reports/metrics lists every key with its label under categories. Older records can have a retired key that is not in that list.

Example:

"cancellation"

customer
object
phone_line
object
duration_seconds
integer | null
Example:

214

has_recording
boolean

True when GET /conversations/{conversation_id}/recording has audio to stream. For some calls the recording provider stores the audio and can delete it, so true can still get a 404.

questions
object[]
task
object

The task this conversation created. Null when it created none.

transcript
object | null

The spoken transcript of a phone call. Null for texts, chats, and emails.

written
object | null

Texts, chat messages, and emails in the conversation. A long thread returns one page of messages, the newest page unless you pass before. Every other field is the same with or without before.

notes
object[]

Internal notes on the conversation, oldest first and newest last. Only your team sees them.

notes_truncated
boolean

True when older notes were left out or a very long note was cut.

omitted_notes
integer

How many older notes were left out because the conversation has more notes than fit. The newest notes are always kept.