Creators · Ledger
Fetches ledger balances.
Request
Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Keys with the money resource group disabled get 403 resource_group_disabled. Authentication
This endpoint is enabled per workspace. Until it is, calls return 403 feature_not_available. Email support@pozy.ai to turn it on.
Query parameters
| Name | Type | Notes |
|---|---|---|
scopeTyperequired | string | |
scopeIdrequired | string | |
currency | string | Default usd |
Example
curl -X GET "https://api.pozy.ai/v1/ledger/balances?scopeType=string&scopeId=6c4ddacb1bf27185a5c9a056" \
-H "Authorization: Bearer $POZY_API_KEY"const res = await fetch("https://api.pozy.ai/v1/ledger/balances?scopeType=string&scopeId=6c4ddacb1bf27185a5c9a056", {
headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);import os
import requests
resp = requests.get(
"https://api.pozy.ai/v1/ledger/balances",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
params={
"scopeType": "string",
"scopeId": "6c4ddacb1bf27185a5c9a056",
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
scopeTypestringscopeIdstringcurrencystringbalancesmap of integer
200 response
{
"scopeType": "string",
"scopeId": "6c4ddacb1bf27185a5c9a056",
"currency": "USD",
"balances": {
"key": 1
}
}Errors
Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:
| 400 | invalid_request_error | A parameter or body field is missing or invalid. param names it. |
| 401 | authentication_error | The API key is missing, revoked or expired. |
| 403 | permission_error | The key is scoped to other profiles or has this resource group disabled. |
| 429 | rate_limit_error | Too many requests this minute. Wait for Retry-After seconds. |
Every code is listed in Errors.