List budget ledgers
GET
/v1/admin/budgets
Query budget ledgers by tenant, scope pattern, or status. Returns all units for matching scopes.
AUTHORIZATION: - Tenant can list their own budgets only (scoped by ApiKeyAuth)
Authorizations
ApiKeyAuth
Tenant-scoped API key for runtime operations (consistent with Cycles Protocol)
Type
API Key (header: X-Cycles-API-Key)
Parameters
Query Parameters
tenant_id*
Type
Requiredstring
scope_prefix
Filter by scope prefix, e.g., "tenant:acme-corp/workspace:eng"
Type
string
unit
Type
string
Valid values
"USD_MICROCENTS""TOKENS""CREDITS""RISK_POINTS"status
Type
string
Valid values
"ACTIVE""FROZEN""CLOSED"cursor
Type
string
limit
Type
integer
Default
50Responses
Budget list
application/json
JSON "ledgers": [ { "ledger_id": "string", "scope": "string", "scope_path": "string", "unit": "string", "allocated": { "unit": "string", "amount": 0 }, "remaining": { "unit": "string", "amount": 0 }, "reserved": { "unit": "string", "amount": 0 }, "spent": { "unit": "string", "amount": 0 }, "debt": { "unit": "string", "amount": 0 }, "overdraft_limit": { "unit": "string", "amount": 0 }, "is_over_limit": true, "commit_overage_policy": "string", "status": "string", "rollover_policy": "string", "period_start": "string", "period_end": "string", "created_at": "string", "updated_at": "string" } ], "next_cursor": "string", "has_more": true
{
}