API

List budgets

List budgets the signed-in Ultra user can access.

Returns budgets the token’s user owns or can edit as a collaborator.

GET/v1/list_budgets

Query

FieldTypeRequiredDefaultDescription
(none)———No parameters.

Response data

FieldTypeDescription
(array)object[]Top-level data is an array of budgets (not { items }).

Item fields

FieldTypeDescription
idstringUnique budget id.
namestringHuman-readable name shown in the app.
baseCurrencystringISO 4217 currency code.
monthlyNetIncomenumberMonthly net income in base currency.
unallocatedAmountnumberUnallocated balance in base currency.
refillDaynumberCalendar day (1–31) when unallocated balance refills each month.
citystringOptional city used for cost-of-living context; may be null.
ownerIdstringFirebase uid of the budget owner.