List study submissions | Prolific API

Returns basic information of the submissions, including the study id, participant id, status and start timestamp

Authentication

AuthorizationToken

Header authentication of the form Token <token>

Path parameters

idstringRequired

Study id

Query parameters

orderingstringOptional

Field to sort results by. Prefix with - for descending order. Allowed values: started_at, completed_at, status, ip, time_taken, participant_id, study_code.

Response

List submissions

resultslist of objects

List of all submissions matching the criteria.

1	import requests
2
3	url = "https://api.prolific.com/api/v1/studies/id/submissions/"
4
5	headers = {"Authorization": "Token <token>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

1	{
2	"results": [
3	{
4	"id": "subm-1234567890abcdef",
5	"participant_id": "part-9876543210fedcba",
6	"status": "COMPLETED",
7	"started_at": "2024-01-15T09:30:00Z",
8	"has_siblings": false,
9	"completed_at": "2024-01-15T10:45:00Z",
10	"study_code": "STUDY-2024-001",
11	"return_requested": "2024-01-20T12:00:00Z"
12	}
13	]
14	}

Authentication

Path parameters

Query parameters

Response

Errors