List all studies

GET

https://api.prolific.com/api/v1/studies/

GET

/api/v1/studies/

1 import requests
2 
3 url = "https://api.prolific.com/api/v1/studies/"
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": "a3f47b9e-8c2d-4f1a-9b7e-2d5f3c6a7e8b",
5       "name": "Cognitive Behavioral Therapy Study",
6       "internal_name": "cbt_study_2024",
7       "status": "UNPUBLISHED",
8       "study_type": "SINGLE",
9       "total_available_places": 150,
10       "places_taken": 45,
11       "number_of_submissions": 120,
12       "reward": 50,
13       "total_cost": 7500,
14       "published_at": "2024-01-15T09:30:00Z",
15       "publish_at": "2024-01-15T09:30:00Z",
16       "date_created": "2024-01-10T08:00:00Z",
17       "credential_pool_id": "pool-9f8e7d6c-1234-5678-9abc-def012345678"
18     }
19   ]
20 }

List all studies, with the option to filter by study status.

Authentication

AuthorizationToken

Header authentication of the form Token <token>

Query parameters

stateenumOptional

Filter studies by status. Accepts a string in the format “(active|published|…)”, where “active” and “published” are example statuses.

Response

List of studies

resultslist of objects

List of all studies matching the criteria.

Authentication

Query parameters

Response

Errors