API

List boxes

List expense boxes on a budget.

Lists expense boxes for a budget.

GET/v1/list_boxes

Query

FieldTypeRequiredDefaultDescription
budgetIdstringYes—Budget whose expense boxes to list.

Response data

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

Item fields

FieldTypeDescription
idstringUnique id of this expense box.
namestringHuman-readable name shown in the app.
descriptionstringFree-text description or memo when present.
currencystringISO 4217 currency code.
amountnumberAmount allocated to this box.
sortOrdernumberSort position when the budget has an explicit order.
typestringCategory written by Tools API create/update (e.g. needs / wants / savings).
categorystringCategory on app-synced boxes (same role as type; may appear instead of or alongside type).
iconstringIcon key when set in the app.
iconColorstringCurated icon circle fill key when set.
goalAmountnumberOptional accumulate-to target amount.
paymentModestringaccount or creditCard when a funding account is linked.
creditCycleEndDaynumberStatement closing day (1–31) when present on credit-funded boxes.
accountLinkIdstringId of the AccountLink funding this box, when linked.
isDeletedbooleanSoft-delete flag when present on the stored document.
deletedAtstringISO-8601 soft-delete timestamp when present.
createdAtstringCreation timestamp when present (API-created boxes).
updatedAtstringLast update timestamp when present.