Skip to main content
GET
Get a conversation

Headers

x-anyreach-org
string | null

Organization ID for user PATs (pat_ prefix tokens)

Path Parameters

conversation_id
string
required

The conversation's unique ID.

Query Parameters

include_fields
string | null

Response

Successful Response

Partial conversation schema for list responses with specific columns.

id
string | null
organization_id
string | null
trunk_id
string | null
trunk_config
Trunk Config · object | null
direction
enum<string> | null

Direction of the conversation.

Available options:
inbound,
outbound
agent_id
string | null
agent_version_id
string | null
web_widget_id
string | null
agent_config
AgentConfig · object | null

Top-level agent configuration.

user_id
string | null
agent_number
string | null
channel
enum<string> | null

Channel type for the conversation.

Available options:
telephone,
webrtc,
email,
text
duration
integer | null
user_turn_count
integer | null
user_name
string
default:""
recording_details
RecordingDetail · object | null
custom_metadata
Custom Metadata · object | null
system_metadata
System Metadata · object | null
conversation
Conversation · object | null
sip
Sip · object | null
initial_context
string
default:""
summary
string
default:""
status
enum<string> | null

Status of the conversation.

Available options:
token_created,
triggered,
ringing,
in_progress,
completed,
failed,
cancelled,
transferred,
unanswered
service_version
string | null
created_at
string<date-time> | null
updated_at
string<date-time> | null
created_by
string | null
modified_by
string | null
agent
ConversationAgent · object | null

Agent reference with id and name.