Request a Collection Export

Initiates an asynchronous export of all participant responses and uploaded files for a collection as a ZIP archive.

The export is generated out-of-band to handle large collections 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 /collections/{collection_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 collection 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 collection can request an export.

Initiates an asynchronous export of all participant responses and uploaded files for a collection as a ZIP archive. The export is generated out-of-band to handle large collections 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 /collections/{collection_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 collection 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 collection can request an export.

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

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

collection_idstringRequired

Response

Export already complete

statusenum

Allowed values:

urlstringformat: "uri"

Presigned HTTPS URL for downloading the ZIP archive. Valid for 1 hour. Re-poll to get a refreshed URL if expired.

expires_atdatetime

ISO 8601 timestamp indicating when the presigned URL expires.

Errors

403

Forbidden Error

Initiates an asynchronous export of all participant responses and uploaded files for a collection as a ZIP archive.

The export is generated out-of-band to handle large collections 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 /collections/{collection_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 collection 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 collection can request an export.

$	curl -X POST https://api.prolific.com/api/v1/data-collection/collections/collection_id/export \
>	-H "Authorization: Token <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"status": "complete",
3	"url": "https://prolific-export.s3.eu-west-1.amazonaws.com/exports/123e4567-e89b-12d3-a456-426614174000.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20240601%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20240601T120000Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890",
4	"expires_at": "2024-01-15T09:30:00Z"
5	}