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

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:
true,
false

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,
wechat,
kakao,
zalo
status
enum<string>
Available options:
open,
closed,
pending,
snoozed,
active,
archived,
resolved
assigned_agent
string
tag
string
channels
string
statuses
string
tags
string
assignee
string
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
last_message_direction
enum<string>
Available options:
inbound,
outbound
filters
string

Response

Successful response.