API

List notifications

List the signed-in user’s notification inbox with translated title and body.

Returns the user’s notification inbox (30-day retention) with server-translated title and body. Optional locale (see Locales); when omitted, uses preferredLanguage, else en. Paginate with pageToken / limit (default 30, max 100).

GET/v1/list_notifications

Query

FieldTypeRequiredDefaultDescription
localestringNo—Supported locale code. Omit to use the user’s preferred language.
pageTokenstringNo—Cursor from a previous response’s nextPageToken.
limitnumberNo30Page size (1–100; default 30).

Response data

FieldTypeDescription
localestringLocale used for title/body.
itemsarrayInbox notifications.
nextPageTokenstringPass as pageToken for the next page when present.

Item fields

FieldTypeDescription
idstringNotification id.
typestringNotification type (e.g. budget_update), or null.
budgetIdstringRelated budget id when present, or null.
budgetNamestringRelated budget name when present, or null.
createdAtstringISO-8601 creation time, or null.
readAtstringISO-8601 when marked read, or null.
titlestringTranslated title.
bodystringTranslated body.