Skip to main content
POST
Export contacts to a downloadable file

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Body

application/json
contact_ids
string[]

Explicit contact ids to export (max 50,000). Provide this OR filters.

filters
object

Segment filter AST resolving the audience server-side. Provide this OR contact_ids.

format
enum<string>
default:csv

Output file format.

Available options:
csv
timezone
string

IANA timezone used to render timestamp columns (e.g. Europe/Istanbul). Defaults to UTC when omitted.

Maximum string length: 64

Response

202 - application/json

Export accepted and queued; poll the returned job id, then download when complete.

data
object
meta
object