List all studies in a project

import requests
url = "https://api.prolific.com/api/v1/projects/project_id/studies/"
headers = {"Authorization": "Token <token>"}
response = requests.get(url, headers=headers)
print(response.json())

{
  "results": [
    {
      "id": "a3f47b2e-9c4d-4f1a-8b2e-7d9f3c5a1e2b",
      "name": "Cognitive Bias Study",
      "internal_name": "cog_bias_2024_q1",
      "status": "UNPUBLISHED",
      "study_type": "SINGLE",
      "total_available_places": 100,
      "places_taken": 45,
      "number_of_submissions": 120,
      "reward": 15.5,
      "total_cost": 1852.5,
      "published_at": "2024-01-15T09:30:00Z",
      "publish_at": "2024-01-15T09:30:00Z",
      "date_created": "2024-01-10T08:00:00Z",
      "credential_pool_id": "pool-7f9d3c2a"
    }
  ]
}

List all of your studies in a project.

For projects with a large number of studies, pagination can be used to optimize the response size and performance. To paginate, use the page, page_size and ordering query parameters. For example, to retrieve the first 10 studies, use /api/v1/projects/{project_id}/studies/?page=1&page_size=10&ordering=-date_created.

Authentication

AuthorizationToken

Header authentication of the form Token <token>

Path parameters

project_idstringRequired

Project id

Query parameters

pageintegerOptional

The page number to retrieve.

page_sizeintegerOptional

The number of studies to retrieve per page.

orderingstringOptional

The ordering of the studies. Use -date_created to order by date created in descending order.

Response

List of studies for the given project

resultslist of objects

List of all studies matching the criteria.

Authentication

Path parameters

Query parameters

Response

Errors