Skip to main content
Tags are open-ended labels attached to transactions. Each tag has a stable slug (for queries and rules) and a display_name (for humans). The review queue is just transactions tagged needs-review β€” a system-seeded rule auto-tags every new transaction during sync, and agents close reviews by removing the tag via update_transactions. The same read surface is also exposed over REST at GET /api/v1/tags.

list_tags

Returns all tags registered in the system. Filter transactions by tag via the tags / any_tag parameters on query_transactions. Scope: Read Mirrors: GET /api/v1/tags (REST endpoint β€” see the admin UI at /tags for the canonical list)

Parameters

None. Pass an empty object.

Example input

{}

Example output

[
  {
    "id": "t1Xm9pQ2",
    "slug": "needs-review",
    "display_name": "Needs Review",
    "description": "Automatically added by sync; removed when a human or agent closes the review.",
    "color": "#F59E0B",
    "icon": "inbox",
    "created_at": "2026-01-01T00:00:00Z",
    "updated_at": "2026-01-01T00:00:00Z"
  },
  {
    "id": "t2Yn0qR3",
    "slug": "subscription:monthly",
    "display_name": "Monthly Subscription",
    "description": "Recurring monthly charge.",
    "color": "#8B5CF6",
    "icon": "refresh-cw",
    "created_at": "2026-02-14T14:30:00Z",
    "updated_at": "2026-02-14T14:30:00Z"
  }
]
Tag discovery. When agents add a tag via add_transaction_tag or update_transactions with a slug that doesn’t exist yet, Breadbox auto-registers it as a persistent tag with the slug as the display name. Use create_tag up front only when you need to set a custom display name, color, or icon.