v4

OpenAPI 3.1.02026-07-31121440441.0 KB

projects

Create a project

Creates a new project within the workspace. When this project is created, it adds the user as a Project Editor. Set type to PUBLIC to create a public project.

post/api/v1/workspaces/{workspace_id}/projects/

Path parameters

workspace_idstring required

Workspace id

Headers

Authorizationstring required

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>.

Request body

titlestring required

Name of project

descriptionstring

What is this project used for

type'PRIVATE' | 'PUBLIC'

Project visibility type.

naivety_distribution_ratenumber double nullable

Control the balance between speed of your studies and the naivety of the participants.

If not defined, by default Prolific calculates the best rate for most studies taking into account the filters and the total_available_places needed for this study.

Use 0 if your priority is speed. When this property is set to 0 all eligible participants will have access to your study at the same time, without any prioritization.

You can also set this at a workspace and study level.

is_longitudinalboolean

Whether this is a longitudinal (multi-wave) project.

Response

Successfully created project.

idstring required

Project id. It is created by Prolific.

titlestring required

Name of project

descriptionstring

What is this project used for

ownerstring

User id of the creator of the project. It is created by Prolific.

type'PRIVATE' | 'PUBLIC' required

Project visibility type.

workspacestring

Id of the workspace this project is in. This is created by Prolific.

naivety_distribution_ratenumber double nullable

The rate at which the studies within this project are distributed.

is_longitudinalboolean

Whether this is a longitudinal (multi-wave) project.