get-categories

Get transaction categories. Returns a list of categories that transactions can be classified into.

Input

Raw JSON Schema

{
  "additionalProperties": false,
  "properties": {},
  "type": "object"
}

Output

Field	Type	Required	Description
items	array<Category>	✓	Available transaction categories.

items[] — Category

Transaction category for spending classification. bank2ai-defined categorization model; not profiled from a single upstream standard. Localized names live on this object so clients can render category labels per the user's locale; programmatic identity goes through id. See CANONICAL_CATEGORY_IDS for the recommended id values shared across servers.

Field	Type	Required	Description
id	string	✓	Unique category identifier. SHOULD be one of the canonical ids in CANONICAL_CATEGORY_IDS when a server's category maps cleanly; otherwise free-form server-specific. Examples: "Groceries", "DiningAndEntertainment", "Other".
name	string	✓	Category name (localized) Examples: "Groceries", "Transportation", "Entertainment", "Utilities".

Raw JSON Schema

{
  "description": "Envelope for a list of categories",
  "properties": {
    "items": {
      "description": "Available transaction categories.",
      "items": {
        "description": "Transaction category for spending classification.\n\nbank2ai-defined categorization model; not profiled from a single\nupstream standard. Localized names live on this object so clients\ncan render category labels per the user's locale; programmatic\nidentity goes through `id`. See `CANONICAL_CATEGORY_IDS` for the\nrecommended id values shared across servers.",
        "properties": {
          "id": {
            "description": "Unique category identifier. SHOULD be one of the canonical ids in `CANONICAL_CATEGORY_IDS` when a server's category maps cleanly; otherwise free-form server-specific.",
            "examples": [
              "Groceries",
              "DiningAndEntertainment",
              "Other"
            ],
            "type": "string"
          },
          "name": {
            "description": "Category name (localized)",
            "examples": [
              "Groceries",
              "Transportation",
              "Entertainment",
              "Utilities"
            ],
            "type": "string"
          }
        },
        "required": [
          "id",
          "name"
        ],
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "items"
  ],
  "type": "object"
}