Sign in

v4

latestOpenAPI 3.1.02026-07-31121440441.0 KB
workspaces

Create a workspace

Creates a new workspace and adds the user as a Workspace Admin.

post/api/v1/workspaces/

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 workspace

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 project and study level.

currency_codestring

Currency used for all transactions within the workspace. Must be GBP or USD.

Response

Created workspace

idstring required

Workspace id. It is created by Prolific.

titlestring required

Name of workspace

descriptionstring

What is this workspace used for

ownerstring

Workspace id. It is created by Prolific.

walletstring

Wallet tied to workspace

naivety_distribution_ratenumber double nullable

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