Get Batch Export Status

Polls the status of an asynchronous batch export job initiated by POST /batches/{batch_id}/export.

Returns the current status of the export:

generating — the export is still being built; continue polling.
complete — the export is ready; a presigned HTTPS download URL is included. URLs are valid for 24 hours and are automatically refreshed if expired.
failed — generation failed (e.g. the archive was deleted from storage). Re-send POST /batches/{batch_id}/export to retry.

Polls the status of an asynchronous batch export job initiated by `POST /batches/{batch_id}/export`. Returns the current status of the export: - **generating** — the export is still being built; continue polling. - **complete** — the export is ready; a presigned HTTPS download URL is included. URLs are valid for 24 hours and are automatically refreshed if expired. - **failed** — generation failed (e.g. the archive was deleted from storage). Re-send `POST /batches/{batch_id}/export` to retry.

Authentication

AuthorizationToken

Header authentication of the form Token <token>

Path parameters

batch_idstringRequired

export_idstringRequired

Response

Export status

BatchExportStatus0object

An export job that has been enqueued and is currently being generated.

BatchExportStatus1object

An export job that has completed successfully. The ZIP archive is ready to download.

BatchExportStatus2object

An export job that failed to generate, or whose archive has since been deleted. Re-send POST /batches/{batch_id}/export to retry.

Errors

404

Not Found Error