v1

latestOpenAPI 3.1.02026-07-227350156.5 KB

Category Personalization

Get categories

Fetch custom user-level categories from Spade's database.

This endpoint returns a list containing all custom categories that the user with the given userId has created.

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

get/users/{userId}/categories

Response

Successful operation

idstring

A unique identifier for this category.

namestring

The category's name

iconstring url nullable

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

Example response

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