PRprolific
studies

List all studies in a project

Changed on

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.

get/api/v1/projects/{project_id}/studies/

Request

  • Base URL
    https://api.prolific.com
  • URL
    https://api.prolific.com/api/v1/projects/{project_id}/studies/
  • Auth
    API key in header Authorization

Path parameters

project_idstring required

Project id

Query parameters

pageinteger

The page number to retrieve.

page_sizeinteger

The number of studies to retrieve per page.

orderingstring

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

statusstring

Filter studies by status. Accepts a single status, e.g. "ACTIVE", or multiple statuses in the format "(ACTIVE|PAUSED)". Valid statuses are ACTIVE, PAUSED, UNPUBLISHED, PUBLISHING, COMPLETED, AWAITING REVIEW, UNKNOWN and SCHEDULED.

Response

List of studies for the given project

Changes

  • 36e3bb40c638Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 5460576856eeRevision changes
    • info

      added the new optional query request parameter status