API referenceBudgets
Get a budget
Cap, spent, held and remaining.
A budget key sees only its own budget and those nested in it. 404 (not 403) otherwise.
Authorization
bearerAuth AuthorizationBearer <token>
Typecut API key. Generate one in app.typecut.ai → Settings → API keys. Send as Authorization: Bearer tc_live_….
In: header
Path Parameters
id*string
Format
uuidResponse Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/budgets/497f6eca-6276-4993-bfeb-53cbbbba6f08"{
"data": {
"budget_id": "0bce615d-2e25-42ba-b23e-062649572fa6",
"parent_id": "1c6ca187-e61f-4301-8dcb-0e9749e89eef",
"label": "string",
"cap": 0,
"spent": 0,
"held": 0,
"remaining": 0,
"status": "active",
"expires_at": "string",
"created_at": "string"
}
}{
"error": {
"type": "string",
"code": "string",
"message": "string"
}
}{
"error": {
"type": "string",
"code": "string",
"message": "string"
}
}{
"error": {
"type": "string",
"code": "string",
"message": "string"
}
}