GET/api/v1/get-workspace-balances

Get workspace token balances

Returns the token balances of every vault in a workspace, plus a combined total per token across all of them, as a one-call portfolio view.

AccessRequires a permission in the workspaceVIEW_BALANCES

One request covers the whole workspace. vaults holds each vault with its own holdings, and aggregate holds one entry per token with total_balance, the sum of that token across every vault. Each entry under a vault's tokens is a TokenBalance, documented under Shared objects.

Balances and supply figures are raw units, already scaled by each token's decimals, so scale them back before display. For one vault on its own, use GET /api/v1/get-tokens.

note:
Balances can come back partial

A vault whose balances could not be read is still listed, with an error string on its entry. Treat such a response as a complete list of vaults in which some holdings are unknown, rather than as a failed request, and check each vault for error before you total anything yourself.

Query parameters
workspace_idnumberrequired
The workspace whose balances to show. You must hold VIEW_BALANCES in it.