v171

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-0726249111.7 MB
Budgets

List budgets

Returns budgets visible to the current workspace, ordered by creation time with the newest first. Supports filtering by scope kind, scope target id, period, and active state, plus an optional free-text query that searches across denormalized target names via Typesense.

get/v2/budgets

Query parameters

limitinteger

Page size, 1–200. Unset uses the server default (25).

starting_afterstring

Cursor for forward pagination. Set to the budget_id of the last item from the previous page.

ending_beforestring

Cursor for backward pagination. Set to the budget_id of the first item from the previous page.

scope_kindBudgetScopeKind[]

Optional filter: only return budgets whose scope kind matches one of the listed values. Empty means no scope-kind filter.

scope_target_idstring

Optional filter: only return budgets whose scope target id matches.

is_activeboolean

Optional filter: only return budgets with this active state.

periodBudgetPeriod[]

Optional filter: only return budgets whose limits.period matches one of the listed values. Empty means no period filter.

querystring

Optional free-text query. Server translates this into a Typesense search over the denormalized scope_target_name and id fields on the per-workspace {workspace_id}_budgets collection.

sort_by'BUDGET_SORT_FIELD_UNSPECIFIED' | 'BUDGET_SORT_FIELD_EXPIRES_AT' | 'BUDGET_SORT_FIELD_CREATED_AT' | 'BUDGET_SORT_FIELD_UPDATED_AT'

Field used to order the list. Unset orders by most-recently-updated.

Response

OK

objectstring required

Object discriminator for list responses; always list.

hasMoreboolean

Whether more budgets are available in the selected pagination direction.