listAlerts

listAlerts — returns all spending/income alerts owned by the authenticated user.

Use with an AI agent

Export this page as Markdown or bundle it with a task for your agent.

Try a task
0 charactersPage docs attached
Preview the prompt that will be copied

Reference

Authentication: bearer token required (see how to get a token)

listAlerts — returns all spending/income alerts owned by the authenticated user.

Authentication: Required (Bearer token).
Authorization: Caller must have an access binding with role OWNER or COOWNER.

Parameters: none. The caller is identified via the Bearer token and default
personal user binding.

Returns:
- alerts ([]object): Zero or more alert records (ordering is implementation-defined).
  Each alert has: id, userId, amount, category, isIncomeAlert, percentage,
  message, isActive, currentTotal, createdAt, updatedAt (see getAlert for field
  semantics).

Errors:
- permissionDenied: caller lacks OWNER/COOWNER role.
- internal: store failure.

Example request:
{
  "method": "listAlerts",
  "params": {}
}