Get a Budget

get/public/v1/budgets/{budget}

get/public/v1/budgets/{budget}

curl --request GET \
  --url 'https://api.app.astalty.com.au/public/v1/budgets/{budget}' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json'

Response

{
  "data": {
    "id": "b1u2d3g4-e5t6-47a8-9b0c-1d2e3f4a5b6c",
    "name": "2026 Schedule of Supports",
    "description": "Initial quote for the 2026 plan period",
    "type": "internal",
    "start": "2026-01-01T00:00:00+00:00",
    "end": "2026-12-31T00:00:00+00:00",
    "total": 4500000,
    "has_funding_schedule": true,
    "archived_at": null,
    "created_at": "2026-01-01T09:00:00+00:00"
  }
}

Authorization

Authorizationstringrequired
Bearer authentication header of the form Bearer <token>, where <token> is your API key. See How to set up an API key.

Path parameters

budgetstringrequired
The budget UUID

Response

200application/json

BudgetResource

dataobjectrequired
▶Show 10 child attributesHide child attributes
- idstringrequired
  Example:b1u2d3g4-e5t6-47a8-9b0c-1d2e3f4a5b6c
- namestringrequired
  Example:2026 Schedule of Supports
- descriptionstring | nullrequired
  Example:Initial quote for the 2026 plan period
- typestringrequired
  Example:internal
- startstringrequired
  Example:2026-01-01T00:00:00+00:00
- endstringrequired
  Example:2026-12-31T00:00:00+00:00
- totalintegerrequired
  Example:4500000
- has_funding_schedulebooleanrequired
  Example:true
- archived_atstring | nullrequired
- created_atstringrequired
  Example:2026-01-01T09:00:00+00:00

Errors

401Unauthenticated
403Authorization error
404Not found

Command Palette

Authorization

Path parameters

Response

Errors