Exports

Queues an export of one or more destination sheets. One slug produces a CSV, several produce a ZIP. Poll the returned status_url for the download link.

post/migrations/{migration_id}/exports

Request

Request body

slugstring
slugsstring[]
fieldsstring[]

Column names to export, in the order given. Omit to export every column. Matched exactly and case-sensitively; an unrecognised name returns 400 rather than being ignored.

omit_emptyboolean

Drop columns with no data in any row, using the completed import's stored per-column coverage. Returns 409 (coverage_unavailable) when that coverage does not exist, rather than quietly exporting every column.

Example request

{
  "fields": [
    "Email",
    "Company Name"
  ]
}

Response

Export queued.

job_idstring
status'pending'
format'csv' | 'zip'
total_rowsinteger
status_urlstring

Relative path of this job's status endpoint.

Changes