Skip to main content
GET
Get the budget hierarchy as a tree of up to 200 budgets, refused past it; for each, its limit, period spend, burn rate, days until exhausted, status and triggered alert count.

Authorizations

Authorization
string
header
required

A platform API key, created in the Console under Developers. Pass as Authorization: Bearer <key>. It acts as itself, under its role grants narrowed by its scopes.

Query Parameters

limit
integer

The list is bounded: at most 200 items, the budget tree's node maximum (BUDGET_TREE_NODE_CAP): a hierarchy past it is refused as 409 conflict (BUDGET_TREE_TOO_LARGE), never answered as a cut tree. Every answer is the whole list, so meta.hasMore is false. limit (1 to 1000) does not cut it.

Required range: 1 <= x <= 1000
cursor
string

A bounded list issues no cursor: meta.nextCursor is always null, and any cursor is 400.

Minimum string length: 1

Response

Get the budget hierarchy as a tree of up to 200 budgets, refused past it; for each, its limit, period spend, burn rate, days until exhausted, status and triggered alert count.

data
object[]
required
meta
object
required

A list page's continuation. While hasMore is true, nextCursor is a string: pass it as cursor for the next page. hasMore: false ends the list; with truncated: true, more exist past what this list reads, and no cursor reaches them.