Skip to main content
GET
/
budgets
/
{budget_token}
Get budget by token
curl --request GET \
  --url https://api.vantage.sh/v2/budgets/{budget_token} \
  --header 'Authorization: Bearer <token>'
{
  "token": "bdgt_24068dbacaaad7fb",
  "name": "Total",
  "workspace_token": "wrkspc_545a937d68541448",
  "user_token": "usr_470d15b368844366",
  "created_by_token": "usr_470d15b368844366",
  "cost_report_token": "rprt_9ee9f29893956951",
  "created_at": "2024-07-11T20:22:41Z",
  "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.

Path Parameters

​
budget_token
string
required

Query Parameters

​
include_performance
boolean

Include performance data.

Response

Budget model

​
token
string
​
name
string

The name of the Budget.

Example:

"Acme123 Budget"

​
workspace_token
string

The token for the Workspace the Budget is a part of.

​
user_token
string

The token for the User who created this Budget.

​
created_by_token
string

The token of the Creator of the Budget.

​
cost_report_token
string

The token of the Report associated with the Budget.

​
created_at
string

The date and time, in UTC, the Budget was created. ISO 8601 Formatted.

Example:

"2024-03-19T00:00:00Z"

​
budget_alert_tokens
string[]

The tokens of the BudgetAlerts associated with the Budget.

​
child_budget_tokens
string[]

The tokens of the child Budgets associated with the hierarchical Budget.

​
periods
object[]

The budget periods associated with the Budget.

​
performance
object[]

The historical performance of the Budget.