Pular para o conteúdo principal
GET
List budgets
Guia relacionado: Guia de orçamentos. Consulte o Guia de orçamentos para ver um passo a passo com exemplos.

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parâmetros de consulta

limit
integer<int32>

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

starting_after
string

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

ending_before
string

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

scope_kind
enum<string>[]

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

Opções disponíveis:
BUDGET_SCOPE_KIND_WORKSPACE,
BUDGET_SCOPE_KIND_PROJECT,
BUDGET_SCOPE_KIND_IDENTITY,
BUDGET_SCOPE_KIND_API_KEY,
BUDGET_SCOPE_KIND_PROVIDER,
BUDGET_SCOPE_KIND_MODEL
scope_target_id
string

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

is_active
boolean

Optional filter: only return budgets with this active state.

period
enum<string>[]

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

Opções disponíveis:
BUDGET_PERIOD_DAILY,
BUDGET_PERIOD_WEEKLY,
BUDGET_PERIOD_MONTHLY,
BUDGET_PERIOD_YEARLY,
BUDGET_PERIOD_ONE_TIME
query
string

Optional free-text query matched against a budget's scope target name and id.

sort_by
enum<string>

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

Opções disponíveis:
BUDGET_SORT_FIELD_EXPIRES_AT,
BUDGET_SORT_FIELD_CREATED_AT,
BUDGET_SORT_FIELD_UPDATED_AT

Resposta

OK

object
string
obrigatório

Object discriminator for list responses; always list.

data
object[]
obrigatório

Page of budgets, ordered newest first.

hasMore
boolean
padrão:false

Whether more budgets are available in the selected pagination direction.