v4
OpenAPI 3.1.02026-07-31121440441.0 KBRequest a Batch Export
Initiates an asynchronous export of all participant responses and uploaded files for a batch as a ZIP archive.
The export is generated out-of-band to handle large batches without hitting API timeout limits. The endpoint returns immediately with one of two outcomes:
- 202 Accepted — a new export job has been enqueued. Use the returned export_id to poll GET /batches/{batch_id}/export/{export_id} for status.
- 200 OK — a recent export already exists and is ready to download immediately.
Subsequent POST requests for the same batch are idempotent while an export is generating or complete; they return the existing job ID or download URL rather than re-triggering generation.
Only researchers with workspace access to the batch can request an export.
Path parameters
Headers
The Prolific API uses API token to authenticate requests. You can create an API token directly from your settings.
Your API token does not have an expiry date and carries full permission, so be sure to keep them secure.
If your token is leaked, delete it and create a new one directly in the app.
In your requests add Authorization header with the value Token <your token>.
Response
Export already complete