Skip to main content
POST
Start contact export job

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
fields
string[]
required

Contact fields to include as CSV columns, e.g. sys:firstName, sys:email, or a custom field id.

Minimum array length: 1
contactIds
string[]

Specific contact ids to export. Required unless exportAll is true.

Pattern: ^\d+$
exportAll
boolean

Export every contact matching filter (or the whole workspace if omitted).

filter
object

Narrows which contacts exportAll exports.

Response

OK

fileId
string
required

Export file id (numeric string). Poll contacts.getExportFile with it.

Pattern: ^\d+$