v1

latestOpenAPI 3.1.02026-07-227350156.5 KB

Category Personalization

Get all default and custom integration-level categories

Fetch categories from Spade's database.

This endpoint returns a list containing Spade's default categories, plus any custom integration-level categories you've created.

To learn more about category personalization, please read the Category Personalization Guide.

get/categories

Query parameters

includestring

Example:default

An optional comma-separated string specifying which category types to include. Valid values include 'default', 'custom', 'default,custom'.

Response

Successful operation

idstring

A unique identifier for this category. This identifier will show up in enrichments as counterparty[i].industry[-1].id, where i is the index of this merchant in the counterparty list. Note that each counterparty's industry is a list containing its full category hierarchy (including parent categories); thus, this category will be the last one in the industry list.

namestring

The category's name

iconstring url nullable

The category's icon

Example response

[
  {
    "id": "011-010-000-000",
    "name": "Online Marketplace",
    "icon": "https://static.v2.spadeapi.com/categories/b4b0d249b40249acb7445027d4574fc5/light.png",
    "fullCategoryHierarchy": [
      {
        "id": "011-000-000-000",
        "name": "Retail",
        "icon": "https://static.v2.spadeapi.com/categories/ee4ee39fd5474d31ac42f9e606b9040a/light.png"
      },
      {
        "id": "011-010-000-000",
        "name": "Online Marketplace",
        "icon": "https://static.v2.spadeapi.com/categories/b4b0d249b40249acb7445027d4574fc5/light.png"
      }
    ]
  }
]