Get the balance of a workspace

Provides details of the funds available in the workspace.

Authentication

AuthorizationToken

Header authentication of the form Token <token>

Path parameters

workspace_idstringRequired

Workspace id

Response

Success

currency_codestring or null

The currency used for all financial transactions within the workspace.

total_balanceinteger or null

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 or null

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

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 or null

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

available_balance_breakdownobject or null

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

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

1	import requests
2
3	url = "https://api.prolific.com/api/v1/workspaces/workspace_id/balance/"
4
5	headers = {"Authorization": "Token <token>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

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	}

Authentication

Path parameters

Response

Errors