GET
/
categories
Get all default and custom integration-level categories
curl --request GET \
  --url https://east.sandbox.spade.com/categories \
  --header 'X-Api-Key: <api-key>'
[
  {
    "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"
      }
    ]
  }
]

Authorizations

​
X-Api-Key
string
header
required

Query Parameters

​
include
string

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

Examples:

"default"

"custom"

"default,custom"

Response

Successful operation

An array of categories. Spade categories are returned first, followed by custom categories.

​
id
string

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.

Examples:

"011-010-000-000"

​
name
string

The category's name

Examples:

"Online Marketplace"

​
icon
string<url> | null

The category's icon

Examples:

"https://static.v2.spadeapi.com/categories/b4b0d249b40249acb7445027d4574fc5/light.png"

​
fullCategoryHierarchy
object[]

Array with increasingly specific category information.

Examples:
[
  {
    "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"
  }
]