v4

OpenAPI 3.1.02026-07-31121440441.0 KB

workspaces

Get the balance of a workspace

Provides details of the funds available in the workspace.

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

workspace_idstring required

Workspace id

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

Success

currency_codestring

The currency used for all financial transactions within the workspace.

total_balanceinteger

The total balance of the workspace, including funds which have already been assigned to active studies.

All monetary values are shown in the sub-currency of your workspace currency (e.g. pence, cents).

balance_breakdownWorkspaceBalanceBalanceBreakdown

A breakdown of the total balance of the workspace into:

available_balanceinteger

The remaining balance of your workspace which is available to spend, after removing funds assigned to already active studies, etc.

available_balance_breakdownWorkspaceBalanceAvailableBalanceBreakdown

A breakdown of the available balance of the workspace into: