Export demographic data

curl -X POST https://api.prolific.com/api/v1/studies/id/demographic-export/ \
     -H "Authorization: Token <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "filters": []
}'

"Submission id,Participant id,Status,Started at,Completed at,Time taken,Age,Sex,Ethnicity simplified,First language,Current country of residence,Nationality,Country of birth,Student status,Employment status,Reviewed at,Completion code,Total approvals\n507f1f77bcf86cd7994393847,507f191e810c19729de860dsf,APPROVED,2023-10-09T14:30:00.000Z,2023-10-09T14:45:30.000Z,930,28,Female,White,English,United Kingdom,British,United Kingdom,Yes,Employed (full-time),2023-10-09T15:00:00.000Z,ABC123,47\n"

Create and download a demographic export for a study. This endpoint allows you to export participant demographic data with optional study filter data. **Filter Support**: This endpoint supports applying demographic filters to export data for participants who match specific criteria. When filters are provided, the export includes both base demographic data (age, sex, country, etc.) and the filters. When no filters are provided, the export includes only base demographic data for all participants who took the study, excluding any study-specific filter responses. **Export Usage**: Please note that you may only select up to 15 filters per export. You are also limited to 2 different filter export requests. You may download the same request as many times as you need. To check your current usage and see your latest export history, use the [Demographic Export History](https://docs.prolific.com/docs/api-docs/public/#tag/Studies/operation/GetDemographicExportHistory) endpoint. **Basic Data Included**: The export includes the following data fields: * Submission ID * Participant ID * Submission status * Started date-time * Expressed in UTC * ISO 8601 formatted * Completed date-time * Expressed in UTC * ISO 8601 formatted * Time taken (in seconds) * Age * Sex * Participants were asked the following question: What is your sex, as recorded on legal/official documents? * Ethnicity (simplified) * First language * Current country of residence * Nationality * Country of birth * Student status * Employment status * Reviewed at date-time * Expressed in UTC * ISO 8601 formatted * Completion code ('entered code') * Total approvals Learn more on [Exporting Prolific demographic data](https://researcher-help.prolific.com/en/article/b2943f).

curl -X POST https://api.prolific.com/api/v1/studies/id/demographic-export/ \
     -H "Authorization: Token <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "filters": []
}'

"Submission id,Participant id,Status,Started at,Completed at,Time taken,Age,Sex,Ethnicity simplified,First language,Current country of residence,Nationality,Country of birth,Student status,Employment status,Reviewed at,Completion code,Total approvals\n507f1f77bcf86cd7994393847,507f191e810c19729de860dsf,APPROVED,2023-10-09T14:30:00.000Z,2023-10-09T14:45:30.000Z,930,28,Female,White,English,United Kingdom,British,United Kingdom,Yes,Employed (full-time),2023-10-09T15:00:00.000Z,ABC123,47\n"

Create and download a demographic export for a study. This endpoint allows you to export participant demographic data with optional study filter data.

Filter Support: This endpoint supports applying demographic filters to export data for participants who match specific criteria.

When filters are provided, the export includes both base demographic data (age, sex, country, etc.) and the filters.

When no filters are provided, the export includes only base demographic data for all participants who took the study, excluding any study-specific filter responses.

Export Usage: Please note that you may only select up to 15 filters per export. You are also limited to 2 different filter export requests.

You may download the same request as many times as you need. To check your current usage and see your latest export history, use the Demographic Export History endpoint.

Basic Data Included: The export includes the following data fields:

Submission ID
Participant ID
Submission status
Started date-time
- Expressed in UTC
- ISO 8601 formatted
Completed date-time
- Expressed in UTC
- ISO 8601 formatted
Time taken (in seconds)
Age
Sex
- Participants were asked the following question: What is your sex, as recorded on legal/official documents?
Ethnicity (simplified)
First language
Current country of residence
Nationality
Country of birth
Student status
Employment status
Reviewed at date-time
- Expressed in UTC
- ISO 8601 formatted
Completion code (‘entered code’)
Total approvals

Learn more on Exporting Prolific demographic data.

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

idstringRequired

Study ID

Request

This endpoint expects an object.

filterslist of objectsOptional

List of filters to apply to the demographic export.

When filters are provided, the export includes both base demographic data and responses to the specified filters which were applied to the study.

When empty, only base demographic data (age, sex, country, etc.) for all participants who took the study is exported, excluding study-specific filter responses.

Response

Demographic data exported successfully

Errors

4XX

Client Request Error

$	curl -X POST https://api.prolific.com/api/v1/studies/id/demographic-export/ \
>	-H "Authorization: Token <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"filters": []
>	}'