Bulk Download

Download multiple completed exports as a single ZIP file. This is useful when you need to collect results from several export jobs without making individual download requests for each one.

Workflow

Create a bulk download request with export GUIDs
Poll status until the ZIP is ready
Download the ZIP file

bash

POST /api/v1/bulk-download     → { uuid, status: "processing" }
GET  /api/v1/bulk-download/{uuid}  → { status: "ready", downloadUrl }
GET  /api/v1/bulk-download/{uuid}/download  → ZIP binary

Endpoints

Method	Path	Description
`POST`	`/api/v1/bulk-download`	Create a bulk download request
`GET`	`/api/v1/bulk-download/{uuid}`	Check bulk download status
`GET`	`/api/v1/bulk-download/{uuid}/download`	Download the ZIP file

Status Values

Status	Description
`processing`	ZIP is being assembled
`ready`	ZIP is ready to download
`error`	ZIP assembly failed

💡

Export jobs must be completed

Only jobs with a done status can be included in a bulk download. Passing the GUID of a job that is still processing or has errored will cause that file to be skipped or the request to fail.