API ReferenceProjects

Get project

View as MarkdownOpen in Claude
Gets a project's details

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

project_idstringRequired
Project id

Response

Success
idstring
Project id. It is created by Prolific.
titlestring
Name of project
typeenum
Project visibility type.
descriptionstring
What is this project used for
ownerstring
User id of the creator of the project. It is created by Prolific.
public_detailsobject or null

Public metadata for PUBLIC projects. null for PRIVATE projects.

userslist of objects
Data for all users who have access to this project
workspacestring
Id of the workspace this project is in. This is created by Prolific.
naivety_distribution_ratedouble or null0-1Deprecated
The rate at which the studies within this project are distributed.

Errors

4XX
Client Request Error