PRprolific
workspaces

Create a workspace

Changed on

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

post/api/v1/workspaces/

Request

  • Base URL
    https://api.prolific.com
  • URL
    https://api.prolific.com/api/v1/workspaces/
  • Auth
    API key in header Authorization

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.

minimum_reward_per_hourinteger nullable

Minimum reward per hour for studies in this workspace, in hundredths of a penny or cent of the workspace's currency (for example, 300000 is 30.00 per hour). Applies in addition to Prolific's platform minimum. null means no workspace minimum is set, so only Prolific's minimum applies.

This is read-only: to enable a workspace-wide minimum reward per hour, contact Prolific support.

Changes

  • 36e3bb40c638Revision changes
    • info

      added the optional property to the response with the status

  • 6c9aa73fa51fRevision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security token was added to the API