Get the balance of a workspace

Provides details of the funds available in the workspace.

AuthorizationToken

Header authentication of the form Token <token>

workspace_idstringRequired

Workspace id

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:

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:

4XX

Client Request Error

1	{
2	"currency_code": "GBP",
3	"total_balance": 630,
4	"balance_breakdown": {
5	"rewards": 450,
6	"fees": 150,
7	"vat": 30
8	},
9	"available_balance": 210,
10	"available_balance_breakdown": {
11	"rewards": 150,
12	"fees": 50,
13	"vat": 10
14	}
15	}