Export contacts as CSV

GET

/v1/contacts/export

The list with the same filters (for example ?consent=email_marketing) as a CSV for an email tool, stored for 15 minutes behind a time-limited download_url. The link carries a random id and needs no key. Columns: email, first_seen_at, source, stage, consents (space-separated), waitlist_status, changelog_subscribed, feedback_count, stripe_status, plan, mrr, currency, then one detail_<name> column per detail found. Cells that start like a spreadsheet formula are escaped. At most 10,000 rows; truncated says when there were more.

Auth: Secret key only. Indie and up.

Authorizations

SecretApiKey

Parameters

Query Parameters

paying

boolean

has_feedback

boolean

status

string

Allowed values: waiting invited unsubscribed

source

string

stage

string

Allowed values: potential in_talks customer recurring not_a_fit inactive

string

Part of an email address.

consent

string

/^[a-z][a-z0-9_]{0,39}$/

Only people who have granted this consent now, such as email_marketing. waitlist and changelog are built in: on the waitlist and not unsubscribed, and subscribed to the changelog.

detail

string

name for people who have that detail, or name=value for that value (any case), such as stage=building.

Responses

200

{ download_url, expires_at, row_count, truncated, format: "csv" }, the link valid for 15 minutes

400

Error envelope. See error.code for the discriminator.

object

data

required

null

error

required

object

code

required

string

message

required

string

remediation

required

string

doc_url

string format: uri

param

string

request_id

string

meta

object

key

additional properties

401

Error envelope. See error.code for the discriminator.

object

data

required

null

error

required

object

code

required

string

message

required

string

remediation

required

string

doc_url

string format: uri

param

string

request_id

string

meta

object

key

additional properties

403

Error envelope. See error.code for the discriminator.

object

data

required

null

error

required

object

code

required

string

message

required

string

remediation

required

string

doc_url

string format: uri

param

string

request_id

string

meta

object

key

additional properties