List Categories

Retrieve all product categories.

Updated March 29, 2026

On this page

Overview

Fetch all categories for navigation menus, sidebars, and filter UIs. Categories support nesting (parent/child) for hierarchical navigation.

SDK Usage

typescript

import dash from "@/lib/dash"

// Flat list of all categories
const { categories } = await dash.categories.list()

// Nested tree structure
const { categories: tree } = await dash.categories.getTree()

// Categories at a specific depth
const { categories: topLevel } = await dash.categories.getByDepth(0)

// Children of a specific category
const { categories: children } = await dash.categories.getChildren("flower")

Parameter	Type	Description
`tree`	boolean	Return categories as a nested tree
`parent`	string	Filter by parent category slug
`depth`	number	Filter by nesting depth (0 = top-level)
`customFields`	object	Filter by custom field values

json

{
  "id": "cat_abc123",
  "name": "Flower",
  "slug": "flower",
  "description": "Premium cannabis flower",
  "image": "https://cdn.dashfordevs.com/...",
  "hero_image": "https://...",
  "parent_id": null,
  "navbar_name": "Flower",
  "navbar_caption": "Shop our flower collection",
  "show_in_home": true,
  "custom_fields": {},
  "seo_title": "Shop Flower",
  "seo_description": "Browse our flower selection"
}

json

[
  {
    "id": "cat_1",
    "name": "Flower",
    "slug": "flower",
    "children": [
      { "id": "cat_2", "name": "Indica", "slug": "indica", "children": [] },
      { "id": "cat_3", "name": "Sativa", "slug": "sativa", "children": [] }
    ]
  },
  {
    "id": "cat_4",
    "name": "Edibles",
    "slug": "edibles",
    "children": []
  }
]

typescript

// app/components/CategoryNav.tsx
import dash from "@/lib/dash"

export default async function CategoryNav() {
  const { categories } = await dash.categories.getTree()

  return (
    <nav>
      {categories.map(cat => (
        <div key={cat.id}>
          <a href={`/category/${cat.slug}`}>{cat.name}</a>
          {cat.children?.length > 0 && (
            <ul>
              {cat.children.map(child => (
                <li key={child.id}>
                  <a href={`/category/${child.slug}`}>{child.name}</a>
                </li>
              ))}
            </ul>
          )}
        </div>
      ))}
    </nav>
  )
}

List Categories

List Categories

Overview

SDK Usage

Parameters

Category Object

Tree Structure

Navigation Example

REST API

Next Steps