PRprolific
workspaces

Get the balance of a workspace

Changed on

Provides details of the funds available in the workspace.

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

Request

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

Path parameters

workspace_idstring required

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_breakdownWorkspaceBalanceBalanceBreakdown

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_breakdownWorkspaceBalanceAvailableBalanceBreakdown

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

Changes

  • 6c9aa73fa51fRevision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security token was added to the API

  • e9e1e322aacbRevision changes
    • info

      api operation id get-workspace-balance removed and replaced with workspaces_GetWorkspaceBalance