List Batch Export Jobs

GET

https://api.prolific.com/api/v1/data-collection/batches/:batch_id/export

GET

/api/v1/data-collection/batches/:batch_id/export

curl https://api.prolific.com/api/v1/data-collection/batches/batch_id/export \
     -H "Authorization: Token <token>" \
     -H "Content-Type: application/json"

[
  {
    "export_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "filter": {
      "study_id": "study_987654321",
      "from": "2024-04-01T00:00:00Z",
      "to": "2024-04-15T23:59:59Z"
    },
    "status": "generating",
    "created_at": "2024-04-16T10:15:30Z"
  },
  {
    "export_id": "1c2b3a4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "filter": null,
    "status": "complete",
    "created_at": "2024-03-20T14:45:00Z"
  },
  {
    "export_id": "9f8e7d6c-5b4a-3210-9f8e-7d6c5b4a3210",
    "filter": {
      "study_id": "study_123456789",
      "from": "2024-02-01T00:00:00Z",
      "to": "2024-02-28T23:59:59Z"
    },
    "status": "failed",
    "created_at": "2024-03-01T08:00:00Z"
  }
]

Lists every export job requested for a batch, most recent first, including which filter (if any) each was scoped to.

Manually deleted export jobs are excluded — from this list, a deleted export is indistinguishable from one that was never requested. Use GET /batches/{batch_id}/export/{export_id} for the full status of a specific job, including its download URL if complete.

Only researchers with workspace access to the batch can list its export jobs.

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

Response

Export jobs for this batch

export_idstringformat: "uuid"

The export job ID. Use this with GET /batches/{batch_id}/export/{export_id} for full status, including the download URL if complete.

filterobject or null

The filter this export job was requested with, or null for an unfiltered (full) export.

statusenum

The export job's current status. Manually deleted jobs never appear in this list.

Allowed values:

created_atdatetime

When the export job was requested.

Errors

403

Forbidden Error