Skip to main content
GET
Export inbox conversations (CSV or JSON)

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Query Parameters

format
enum<string>
default:csv
Available options:
csv,
json
include_messages
enum<string>

When true and format=json, inline each conversation's message transcript + attachments.

Available options:
true,
false
channel
enum<string>
Available options:
sms,
whatsapp,
email,
rcs,
viber,
instagram,
messenger,
line,
telegram,
agent,
voice,
video,
apple_messages,
web_chat
status
enum<string>
Available options:
open,
closed,
pending,
snoozed,
active,
archived,
resolved
assigned_agent
string
tag
string
channels
string

Comma-separated list of channels

statuses
string

Comma-separated list of statuses (open,closed,pending,snoozed,...)

tags
string

Comma-separated tag list (ANY match)

assignee
string

"me", "unassigned", or a user id

date_from
string<date-time>
date_to
string<date-time>
segment_id
string
unread
enum<string>
Available options:
true,
false
has_agent
enum<string>
Available options:
true,
false
has_video_room
enum<string>
Available options:
true,
false
sentiment
enum<string>
Available options:
positive,
neutral,
negative
mentioned_internal
enum<string>
Available options:
true,
false
filters
string

JSON-encoded full filter AST (takes precedence)

Response

A CSV or JSON download (Content-Disposition attachment). The format depends on the format query param.

One flat row per conversation, with a header row. Returned when format=csv (default).