---
title: "Get ledger balances"
method: GET
path: "/v1/ledger/balances"
tags: ["Ledger"]
---

# Get ledger balances

`GET /v1/ledger/balances`

## Request

- Base URL: `https://zernio.com/api`
- URL: `https://zernio.com/api/v1/ledger/balances`
- Auth: HTTP bearer

Returns the balance of each bucket (for example accruing, owed, payable) for one ledger scope.

These return an empty balances object:

- A scope owned by another team.
- For a profile-scoped key (or a member limited to some profiles), any scope other than `campaign` and `participant` scopes of campaigns under its profiles.

## Query parameters

- `scopeType` string, required
- `scopeId` string, required
- `currency` string

## Response `200`

Balances per bucket in cents

- object
  - `scopeType` string
  - `scopeId` string
  - `currency` string
  - `balances` object: Bucket name to balance in cents (credits minus debits)

## Other responses

- `400`: Invalid request
- `403`: The API key is a restricted key (zrk_ prefix) and may not perform this operation. Three cases: 1. The operation's resource group (see the operation's x-resource-group) is disabled on the key. Fix: create a key with the group enabled in the dashboard API keys tab and revoke the old one. 2. The operation is admin-plane (x-resource-group admin-plane: API keys, invites, connected apps, member identity), never grantable to restricted keys. The error reads "Restricted API keys cannot manage API keys, invites, or member identity." Fix: a full-access key or the dashboard, never a new restricted key. 3. On webhook subscription writes, delivery-log reads and replays, a named event maps to a resource group the key does not hold. A restricted key can never create or edit a subscription broader than itself (a no-messages key cannot subscribe to, test-fire, redeliver or read logs for message.* events).

## Changes

- **2026-10-28** `8f2c44dd7550`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/zernio/apis/zernio-api/changes/v1/ledger/balances/get.md)

---

[API](https://skmtc.dev/zernio/apis/zernio-api.md) - [All operations](https://skmtc.dev/zernio/apis/zernio-api/llms.txt) - [OpenAPI document](https://skmtc.dev/zernio/apis/zernio-api/revisions/c319eb5d95b6?raw)
