---
title: "Get the balance of a workspace"
method: GET
path: "/api/v1/workspaces/{workspace_id}/balance/"
tags: ["workspaces"]
---

# Get the balance of a workspace

`GET /api/v1/workspaces/{workspace_id}/balance/`

Provides details of the funds available in the workspace.

## Path parameters

- `workspace_id` string, required

## Headers

- `Authorization` string, required

## Response `200`

Success

- WorkspaceBalance
  - `currency_code` string — The currency used for all financial transactions within the workspace.
  - `total_balance` integer — 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_breakdown` WorkspaceBalanceBalanceBreakdown — 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_balance` integer — The remaining balance of your workspace which is available to spend, after removing funds assigned to already active studies, etc.
  - `available_balance_breakdown` WorkspaceBalanceAvailableBalanceBreakdown — 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

## Other responses

- `400` — Error

---

[API](https://skmtc.dev/prolific/apis/api-reference.md) · [All operations](https://skmtc.dev/prolific/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/prolific/api-reference/revisions/578f400cea53/schema)