Skip to main content
Queues an export and hands back a job_id to poll. Use this instead of Export CSV when the sheet is large enough that a synchronous download would time out, or when you want several sheets in one ZIP rather than a request per sheet. The trade-off is simple: GET .../exports/{slug}.csv is one call and streams immediately but holds the connection for the whole download; this is two calls plus polling but doesn’t.

Authentication

Requires an x-api-key header. See Authentication.

Queue the export

string
One template slug — produces a CSV.
string[]
Several template slugs — produces a ZIP, one CSV per sheet. Wins if both fields are sent.
202 Accepted:
total_rows is known up front, so you can show a progress bar from the first response.

Poll the job

200 OK. Poll until status is completed or failed.
string
pendingrunningcompleted, or failed.
integer | null
Rows written so far. With total_rows, this drives a progress indicator.
integer | null
Size in bytes, once known.
string | null
A time-limited link, present once the job completes. Fetch it promptly and don’t store it — mint a fresh one by polling again if it lapses.
string
When the export file is deleted. After this the job returns nothing to download; queue a new one.
string | null
Why the export failed, when it did.

Errors

Example

Next

  • Export CSV — the synchronous, single-sheet download.
  • Session log — the record of what was imported.