API ReferenceWorkspaces

Get the balance of a workspace

View as MarkdownOpen in Claude
Provides details of the funds available in the workspace.

Authentication

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

Path parameters

workspace_idstringRequired
Workspace id

Response

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_breakdownobject

A breakdown of the total balance of the workspace into:

  • Funds available to pay to participants
  • Funds pre-paid to Prolific for our services
  • Funds for any VAT applied to our Platform fees
available_balanceinteger
The remaining balance of your workspace which is available to spend, after removing funds assigned to already active studies, etc.
available_balance_breakdownobject

A breakdown of the available balance of the workspace into:

  • Funds available to pay to participants
  • Funds pre-paid to Prolific for our services
  • Funds for any VAT applied to our Platform fees

Errors

4XX
Client Request Error