Docs API Reference Product Category/api/v1/product-category/tree

/api/v1/product-category/tree

Returns the full category tree for the organisation in a single call, suitable for rendering navigation menus during server-side rendering. Root categories appear in items; their descendants are nested under children up to maxDepth levels deep. Deleted, inactive, and internal categories are excluded. Within each level items are ordered by position.

productCategorygetApiV1Product-categoryTree

Parameters

2 query

Query parameters

· 2

apiKeystringRequired

Your BizKitHub API key (passed as GET parameter).

Key format: A 32-character string matching: ^(PROD|DEV_|ROOT)[A-Za-z0-9]{28}$
Prefixes: PROD (production key), DEV_ (individual developer), ROOT (system key with no limits). Learn more

ExamplePRODPGrFxpGEtrOZfuWhnoJohUYBXuOE

maxDepthstring | integerOptional

Maximum tree depth, counted inclusively from the root. 1 returns only roots, 2 returns roots and their direct children (default), up to 10. Nodes at the maximum depth always have children: [].

Range: 1–10Default: 2

Example2

Response schema

1 status code documented

200SuccessProduct category tree.

itemsobject[]Required

Root categories with nested descendants up to maxDepth levels.

Each array item:

idstringRequired

Category code (unique identifier).

Examplecat_lighting

namestringRequired

Display name of the category.

ExampleLighting

slugstringRequired

URL-friendly slug.

Examplelighting

descriptionstringOptional

HTML description formatted for frontend display (only present when filled in admin).

b2bbooleanRequired

Whether the category is B2B-only.

childrenany[]Required

Direct child categories. Always present as an array (empty when no children or at maxDepth).

Response example

application/json

{
  "items": [
    {
      "id": "cat_lighting",
      "name": "Lighting",
      "slug": "lighting",
      "description": "example_description",
      "b2b": false,
      "children": []
    }
  ]
}

Request example

GET /api/v1/product-category/tree

get

curl -X GET "https://api.bizkithub.com/api/v1/product-category/tree?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE&maxDepth=2" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key