ORorq-ai
Budgets

List budgets

Changed on

Returns budgets visible to the current workspace, ordered by most recently updated with the newest first. Supports filtering by scope kind, scope target id, period, and active state, plus an optional free-text query that matches scope target names and ids. Requires a Management Key with the Budgets permission; project-scoped API keys cannot manage budgets.

get/v2/budgets

Request

  • Base URL
    https://my.orq.ai
  • URL
    https://my.orq.ai/v2/budgets
  • Auth
    HTTP bearer

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 matched against a budget's scope target name and id.

sort_by'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.

Changes

  • 0b4e519a544fRevision changes
    • breaking

      removed the enum value BUDGET_SORT_FIELD_UNSPECIFIED from the query request parameter sort_by

    • breaking

      removed the enum value BUDGET_PERIOD_UNSPECIFIED from the property items/ of the query request parameter period

    • breaking

      removed the enum value BUDGET_SCOPE_KIND_UNSPECIFIED from the property items/ of the query request parameter scope_kind

    • info

      added the non-success response with the status

    • info

      removed the BUDGET_ALERT_DIMENSION_UNSPECIFIED enum value from the //// response property for the response status

    • info

      removed the BUDGET_PERIOD_UNSPECIFIED enum value from the /// response property for the response status

  • 732aed62833aRevision changes
    • warning

      added the new BUDGET_ALERT_DIMENSION_UNSPECIFIED enum value to the //// response property for the response status

    • warning

      added the new BUDGET_PERIOD_UNSPECIFIED enum value to the /// response property for the response status

    • info

      added the new enum value BUDGET_SORT_FIELD_UNSPECIFIED to the query request parameter sort_by

    • info

      added the enum value BUDGET_PERIOD_UNSPECIFIED to the property items/ of the query request parameter period

    • info

      added the enum value BUDGET_SCOPE_KIND_UNSPECIFIED to the property items/ of the query request parameter scope_kind

    • info

      removed the non-success response with the status