Skip to main content
GET
/
budgets
Get all budgets
curl --request GET \
  --url https://api.vantage.sh/v2/budgets \
  --header 'Authorization: Bearer <token>'
{
  "links": {
    "self": "https://api.vantage.sh/v2/budgets",
    "first": "https://api.vantage.sh/v2/budgets?page=1",
    "next": null,
    "last": "https://api.vantage.sh/v2/budgets?page=1",
    "prev": null
  },
  "budgets": [
    {
      "token": "bdgt_0d825e79a0682cc2",
      "name": "database",
      "workspace_token": "wrkspc_226ab053bd01bb2b",
      "user_token": "usr_8e44c17792242852",
      "created_by_token": "usr_8e44c17792242852",
      "cost_report_token": "rprt_92062240b4ffda91",
      "created_at": "2024-07-11T20:22:49Z",
      "budget_alert_tokens": [],
      "periods": [
        {
          "start_at": "2024-07-01",
          "end_at": "2024-09-30",
          "amount": "10000.0"
        }
      ],
      "performance": [
        {
          "date": "July, 2024",
          "actual": "-100%",
          "amount": "10000.0"
        }
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

page
integer<int32>

The page of results to return.

limit
integer<int32>

The number of results to return. The maximum is 1000.

Response

200 - application/json

Budgets model

budgets
object[]
required