Zernio
APIFor you
Zernio
APIFor you
API Reference

Ledger

List ledger entriesGETGet ledger balancesGET
Dashboard
OverviewPlatformsAPI ReferenceResources
Ledger

Get ledger balances

Returns the balance of each bucket (for example accruing, owed, payable) for one ledger scope. A scope owned by another team returns an empty balances object. A profile-scoped key (or a member limited to some profiles) only reads campaign and participant scopes of campaigns under its profiles; any other scope returns an empty balances object.

GET
/v1/ledger/balances

Authorization

bearerAuth
AuthorizationBearer <token>

API key authentication: send your Zernio API key in the Authorization header, prefixed with Bearer.

In: header

Query Parameters

scopeType*string

Scope type, for example participant or campaign.

scopeId*string

Scope identifier.

currency?string

Lowercase ISO 4217 currency code.

Default"usd"

Response Body

application/json

application/json

application/json

import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.ledger.getLedgerBalances({  query: {    scopeType: 'string',    scopeId: 'scope_abc123',  },});console.log(data);
{  "scopeType": "string",  "scopeId": "string",  "currency": "string",  "balances": {    "property1": 0,    "property2": 0  }}
Was this page helpful?

List ledger entries

Lists ledger entries for your team, newest first. Filter by scope (matches either side of the entry), kind, or the reference that caused the entry. A profile-scoped key (or a member limited to some profiles) only sees entries of campaigns under its profiles and of their participants; operator and platform scopes stay hidden from it.

List keys

Returns API keys with a preview only, not the full key value. For a regular team member this is their own keys; for the team owner this is every team member's keys, each carrying a `createdBy` field.