Categories

Get a Category

PropertyDescription
MethodGET
Path/open/v1/spaces/$me/categories/{categoryId}
Accept-
Content-Typeapplication/json
DescriptionRetrieves a category by its ID.
  • Request
    • Query
      (empty)
    • Body
      // (empty)
      
  • Response
    type CategoryView = {
      category: Category
    }
    

Get a Category by Slug

PropertyDescription
MethodGET
Path/open/v1/spaces/$me/categories/${slug}
Accept-
Content-Typeapplication/json
DescriptionRetrieves a category by its slug.
  • Request
    • Query
      (empty)
    • Body
      // (empty)
      
  • Response
    type CategoryView = {
      category: Category
    }
    

Batch Get Categories

PropertyDescription
MethodGET
Path/open/v1/spaces/$me/categories/batch
Accept-
Content-Typeapplication/json
DescriptionRetrieves multiple categories by its IDs. Can fetch up to 25 categories at once.
  • Request

    • Query

      ParamRequired?DefaultTypeDescriptionExample
      ids[]O-string[]IDs of categories to fetch.?ids[]=42&ids[]=37
    • Body

      // (empty)
      
  • Response

    type CategoriesView = {
      categories: Category[]
    }