Skip to main content
GET
/
api
/
v1
/
budgets
/
{id}
Retrieve a budget
curl --request GET \
  --url https://app.sure.am/api/v1/budgets/{id} \
  --header 'X-Api-Key: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "start_date": "2023-12-25",
  "end_date": "2023-12-25",
  "name": "<string>",
  "currency": "<string>",
  "initialized": true,
  "current": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "budgeted_spending": "<string>",
  "budgeted_spending_cents": 123,
  "expected_income": "<string>",
  "expected_income_cents": 123,
  "allocated_spending": "<string>",
  "allocated_spending_cents": 123,
  "actual_spending": "<string>",
  "actual_spending_cents": 123,
  "actual_income": "<string>",
  "actual_income_cents": 123,
  "available_to_spend": "<string>",
  "available_to_spend_cents": 123,
  "available_to_allocate": "<string>",
  "available_to_allocate_cents": 123
}

Authorizations

​
X-Api-Key
string
header
required

API key for authentication. Generate one from your account settings.

Path Parameters

​
id
string<uuid>
required

Budget ID

Response

budget retrieved

​
id
string<uuid>
required
​
start_date
string<date>
required
​
end_date
string<date>
required
​
name
string
required
​
currency
string
required
​
initialized
boolean
required
​
current
boolean
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
budgeted_spending
string | null
​
budgeted_spending_cents
integer | null
​
expected_income
string | null
​
expected_income_cents
integer | null
​
allocated_spending
string
​
allocated_spending_cents
integer
​
actual_spending
string
​
actual_spending_cents
integer
​
actual_income
string
​
actual_income_cents
integer
​
available_to_spend
string
​
available_to_spend_cents
integer
​
available_to_allocate
string
​
available_to_allocate_cents
integer