Skip to content
calternal docs

List budgets

GET
/api/v1/money/budgets
curl --request GET \
  --url https://example.com/api/v1/money/budgets \
  --header 'Authorization: Bearer <token>'

List the budgets in the caller’s Money folder. Each item includes its ID, name, currency, scale, folder name, and any ledger problem. Route: /api/v1/money/budgets. Inputs: . Safe reads can use bounded retries.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

The caller’s budgets under Money/

Media typeapplication/json
Array<object>

One budget folder in the User’s Money/ folder.

object
currency
required

Budget currency, ISO 4217.

string
folder
required

Folder name under Money/.

string
id
required

Stable budget ID (budget-id in the frontmatter).

string
name
required

Display name (the # title of Budget.md).

string
problem

Why the files cannot be posted, when they are broken.

string | null
scale
required

Decimal places of currency.

integer format: int32
Examplegenerated
[
  {
    "currency": "example",
    "folder": "example",
    "id": "example",
    "name": "example",
    "problem": "example",
    "scale": 1
  }
]

403

Section titled “403”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}