Sign in

v4

latestOpenAPI 3.1.02026-07-31121440441.0 KB
workspaces

Get workspace

Gets a workspace's details

get/api/v1/workspaces/{workspace_id}/

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

Response

Success

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.