---
title: "GET /v2/budgets"
method: GET
path: "/v2/budgets"
tags: ["budgets"]
---

# GET /v2/budgets

`GET /v2/budgets`

Get a list of Budgets

## Query parameters

- `limit` number
- `cursor` string
- `sort_key` 'last_updated' | 'name' — Sortable Budget properties
- `sort_order` 'asc' | 'desc'
- `expand` string[]

## Headers

- `cloudzero-idempotency-key` string
- `cloudzero-test-key` string

## Response `200`

Successful Operation

- object
  - `pagination` Pagination — Supports programmatic pagination
    - `page_count` integer
    - `item_count` integer
    - `total_count` integer
    - `cursor` object
      - `next_cursor` union
        - string
        - unknown
      - `previous_cursor` union
        - string
        - unknown
      - `has_next` boolean
      - `has_previous` boolean
  - `sorting` BudgetSorting — This response key contains sorting options, where: - `available`: is an object with two keys: - `sort_keys`: list of available sort keys - `sort_orders`: list of available sort orders - `current`: is an array of `{sort_key: sort_order}` objects, the response is sorted in order of this array
    - `available` object
      - `sort_keys` BudgetSortKeys[]
      - `sort_orders` SortOrder[]
    - `current` object[]
      - `sort_key` 'last_updated' | 'name' — Sortable Budget properties
      - `sort_order` 'asc' | 'desc'
  - `filtering` BudgetFiltering — unresolved $ref
  - `budgets` BudgetMaybeCurrentExpanded[]
    - union
      - Budget
        - `name` string, required — Budget name, must be unique within a View
        - `planned_limits` BudgetPlannedLimits, required — Mapping of `period` to planned budget limits for the given period. Supported `period`s are: - `monthly`
          - `monthly` BudgetPlannedLimit, required — Planned limit as a mapping of `date` to `amount`, where - `date` is an timezone aware ISO Formatted string, e.g. `"2022-02-01T00:00:00+00:00"` - `amount` is a Mapping of the literal string `"amount"` to a dollar amount, e.g. `{"amount": "1000.00"}`
        - `view` WithId, required
          - `id` string, required
        - `alerts` BudgetAlerts — Mapping of `1-100` to `Y/N`, where - `1-100` is the percentage of the budget at which to send an alert - `Y/N` is whether or not to send the alert
        - `id` string, required
        - `created` string, required — String representation of an epoch (UTC timestamp)
        - `last_updated` string, required — String representation of an epoch (UTC timestamp)
        - `cost_type` 'real_cost', required — Type of charges included in the cost calculation, currently supports the following values: `real_cost`: filters your bill to only display charges directly related to consumption
        - `granularity` 'monthly', required — Supported periods, e.g. "monthly"
      - BudgetCurrentExpanded
        - `name` string, required — Budget name, must be unique within a View
        - `planned_limits` BudgetPlannedLimits, required — Mapping of `period` to planned budget limits for the given period. Supported `period`s are: - `monthly`
          - `monthly` BudgetPlannedLimit, required — Planned limit as a mapping of `date` to `amount`, where - `date` is an timezone aware ISO Formatted string, e.g. `"2022-02-01T00:00:00+00:00"` - `amount` is a Mapping of the literal string `"amount"` to a dollar amount, e.g. `{"amount": "1000.00"}`
        - `view` WithId, required
          - `id` string, required
        - `alerts` BudgetAlerts — Mapping of `1-100` to `Y/N`, where - `1-100` is the percentage of the budget at which to send an alert - `Y/N` is whether or not to send the alert
        - `id` string, required
        - `created` string, required — String representation of an epoch (UTC timestamp)
        - `last_updated` string, required — String representation of an epoch (UTC timestamp)
        - `cost_type` 'real_cost', required — Type of charges included in the cost calculation, currently supports the following values: `real_cost`: filters your bill to only display charges directly related to consumption
        - `granularity` 'monthly', required — Supported periods, e.g. "monthly"
        - `current` BudgetCurrent, required
          - `actual` string, required
          - `planned` string, required

## Other responses

- `400` — Bad Request Error
- `403` — Forbidden

---

[API](https://skmtc.dev/cloudzero/apis/cloudzero-api-v2-resources.md) · [All operations](https://skmtc.dev/cloudzero/apis/cloudzero-api-v2-resources/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/cloudzero/cloudzero-api-v2-resources/revisions/fd805a0e75e5/schema)