v1

latestOpenAPI 3.1.0proprietary2026-07-24156175241.3 KB
Sheets

Export as file (async)

Create an asynchronous job to export the sheet in the given format.

post/v1/sheets/{sheet_id}/export-file-async/{format}

Path parameters

sheet_idinteger required

The id of the sheet.

format'csv' | 'excel' | 'json' | 'jsonl' | 'parquet' required

The format of the exported file.

Query parameters

row_filter'all' | 'clean' | 'errors'

Which rows should be included in the export.

include_unmappedboolean

If unmapped columns should be included in the exported file.

warning_behavior'importAsError' | 'importAsClean'

How warnings should be treated during export.

Response

The request has succeeded.

idinteger

The id of the export job.

status'RUNNING' | 'SUCCESS' | 'ERROR'

The status of the export job.

sheet_export_idinteger

The id of the resulting export file (available when status is SUCCESS).