For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Go to app
DocumentationAPI Reference
DocumentationAPI Reference
  • API Reference
    • Introduction
    • Users
    • Taskflow
    • AI Task Builder
      • Batches
      • Exporting Batch Data
      • Collections
      • Exporting Collection Data
      • Datasets
      • Instructions
      • GETList Batches
      • POSTCreate a Batch
      • GETGet a Batch
      • PATCHUpdate a Batch
      • GETGet Batch Status
      • POSTSetup a Batch
      • GETGet Batch Responses
      • GETGet Batch Report
      • POSTDuplicate a Batch
      • POSTRequest a Batch Export
      • GETGet Batch Export Status
      • POSTCreate a Dataset
      • GETGet Dataset Upload URL
      • GETGet Dataset Status
      • GETGet Batch Instructions
      • POSTCreate Batch Instructions
      • PUTUpdate Batch Instructions
      • GETList Collections
      • POSTCreate a Collection
      • GETGet a Collection
      • PUTUpdate a Collection
      • GETGet Collection Responses
      • POSTRequest a Collection Export
      • GETGet Collection Export Status
    • Studies
    • Representative sample studies
    • Filter Sets
    • Participant Groups
    • Custom Groups
    • Study Distribution
    • Submissions
    • Bonuses
    • Messages
    • Workspaces
    • Projects
    • Surveys
    • Webhooks
    • Invitations
    • Reward Recommendations
    • Testing
    • Well Known Endpoints
Go to app
LogoLogo
API ReferenceAI Task Builder

Get Batch Export Status

|View as Markdown|Open in Claude|
GET
https://api.prolific.com/api/v1/data-collection/batches/:batch_id/export/:export_id
GET
/api/v1/data-collection/batches/:batch_id/export/:export_id
$curl https://api.prolific.com/api/v1/data-collection/batches/batch_id/export/export_id \
>     -H "Authorization: Token <token>" \
>     -H "Content-Type: application/json"
1{
2  "status": "generating",
3  "export_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
4}
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 1 hour 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.
Was this page helpful?
Previous

Request a Batch Export

Next

Create a Dataset

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 1 hour 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

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>.

Path parameters

batch_idstringRequired
export_idstringRequired

Response

Export status
object
An export job that has been enqueued and is currently being generated.
OR
object
An export job that has completed successfully. The ZIP archive is ready to download.
OR
object

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