API

List box account alerts

Live linked-account alert conditions (active now) with why-amounts.

Returns live active alert conditions for linked boxes (what the in-app cue shows), not FCM delivery state. Each row includes alertSettings, linkedBalance (box currency), and activeAlerts with why-amounts (balanceThreshold, insufficientForPlan, creditExceedsPayment). Unlinked boxes are omitted unless boxId is set (then linked: false). Historical conditions → get_report.

GET/v1/list_box_account_alerts

Query

FieldTypeRequiredDefaultDescription
budgetIdstringYes—Budget whose linked boxes to evaluate.
boxIdstringNo—Limit to one box (returns linked:false when unlinked).

Response shape: { items }.

Response data

FieldTypeDescription
itemsarrayLinked box alert rows.

Item fields

FieldTypeDescription
boxIdstringExpense box id.
boxNamestringExpense box name.
linkedbooleanFalse only when boxId was requested and the box is unlinked.
sourcestringmanual, bank, or crypto when linked.
alertSettingsobjectConfigured alert settings on the AccountLink.
linkedBalancenumberNet actual in box currency (when linked).
currencystringBox currency for linkedBalance.
activeAlertsarrayCurrently firing alerts with why-amounts.