GET
/
users
/
{userId}
/
categories
Get categories
curl --request GET \
  --url https://east.sandbox.spade.com/users/{userId}/categories \
  --header 'X-Api-Key: <api-key>'
[
  {
    "id": "4d5419f1-bcde-40f5-9168-7f8989b9c55f",
    "name": "Kitchen Remodel",
    "icon": "https://static.v2.spadeapi.com/categories/ee4ee39fd5474d31ac42f9e606b9040a/light.png",
    "fullCategoryHierarchy": [
      {
        "id": "011-000-000-000",
        "name": "Retail",
        "icon": "https://static.v2.spadeapi.com/categories/ee4ee39fd5474d31ac42f9e606b9040a/light.png"
      },
      {
        "id": "4d5419f1-bcde-40f5-9168-7f8989b9c55f",
        "name": "Kitchen Remodel",
        "icon": "https://static.v2.spadeapi.com/categories/ee4ee39fd5474d31ac42f9e606b9040a/light.png"
      }
    ]
  }
]

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
userId
string
required

The userId of the relevant user.

Response

Successful operation

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

​
id
string

A unique identifier for this category.

Examples:

"4d5419f1-bcde-40f5-9168-7f8989b9c55f"

​
name
string

The category's name

Examples:

"Kitchen Remodel"

​
icon
string<url> | null

The category's icon, potentially inherited from the parent category.

Examples:

"https://static.v2.spadeapi.com/categories/ee4ee39fd5474d31ac42f9e606b9040a/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": "4d5419f1-bcde-40f5-9168-7f8989b9c55f",
    "name": "Kitchen Remodel",
    "icon": "https://static.v2.spadeapi.com/categories/ee4ee39fd5474d31ac42f9e606b9040a/light.png"
  }
]