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

objectstring required

Object discriminator for list responses; always list.

hasMoreboolean

Whether more budgets are available in the selected pagination direction.

Changes

Changed in 25 of the 254 revisions of this API.24328

Aug 28, 20269642bb8e4f8311See the full diff
- ▲
  removed the enum value BUDGET_SCOPE_KIND_FACTORY from the property items/ of the query request parameter scope_kind
  request-parameter-property-enum-value-removed
- ●
  removed the optional property data/items/scope/allOf[BudgetScopeRestResponse]/factory from the response with the 200 status
  response-optional-property-removed
This revision also has 39 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 27, 2026a38e9ab597712See the full diff
- ○
  added the enum value BUDGET_SCOPE_KIND_FACTORY to the property items/ of the query request parameter scope_kind
  request-parameter-property-enum-value-added
- ○
  added the optional property data/items/scope/allOf[BudgetScopeRestResponse]/factory to the response with the 200 status
  response-optional-property-added
This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 2, 20266f132f005b2a3See the full diff
- ▲
  the response property data became optional for the status 200
  response-property-became-optional
- ▲
  the response property has_more became optional for the status 200
  response-property-became-optional
- ▲
  the response property object became optional for the status 200
  response-property-became-optional
This revision also has 97 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 31, 20263128fb112d663See the full diff
- ○
  the response property data became required for the status 200
  response-property-became-required
- ○
  the response property has_more became required for the status 200
  response-property-became-required
- ○
  the response property object became required for the status 200
  response-property-became-required
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 30, 2026d1ae9e3491f73See the full diff
- ▲
  the response property data became optional for the status 200
  response-property-became-optional
- ▲
  the response property has_more became optional for the status 200
  response-property-became-optional
- ▲
  the response property object became optional for the status 200
  response-property-became-optional
This revision also has 95 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 29, 202681dd5e8c8ae53See the full diff
- ○
  the response property data became required for the status 200
  response-property-became-required
- ○
  the response property has_more became required for the status 200
  response-property-became-required
- ○
  the response property object became required for the status 200
  response-property-became-required
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 29, 2026c165184caee53See the full diff
- ▲
  the response property data became optional for the status 200
  response-property-became-optional
- ▲
  the response property has_more became optional for the status 200
  response-property-became-optional
- ▲
  the response property object became optional for the status 200
  response-property-became-optional
This revision also has 158 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 29, 202681f63764455c3See the full diff
- ○
  the response property data became required for the status 200
  response-property-became-required
- ○
  the response property has_more became required for the status 200
  response-property-became-required
- ○
  the response property object became required for the status 200
  response-property-became-required
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 29, 20263989ac7bfc9d3See the full diff
- ▲
  the response property data became optional for the status 200
  response-property-became-optional
- ▲
  the response property has_more became optional for the status 200
  response-property-became-optional
- ▲
  the response property object became optional for the status 200
  response-property-became-optional
This revision also has 158 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 28, 2026a16b5d9f224e3See the full diff
- ○
  the response property data became required for the status 200
  response-property-became-required
- ○
  the response property has_more became required for the status 200
  response-property-became-required
- ○
  the response property object became required for the status 200
  response-property-became-required
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 254 revisions, 71 have no diff computed.

Full history (25 revisions)