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

/api/v1/product-category/list

Returns a list of product categories for the organisation. Optionally filter by parent category slug to get only direct children.

productCategorygetApiV1Product-categoryList

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

parentSlugstringOptional

Slug of the parent category to filter children. Omit for root categories.

Exampleexample_parentSlug

Response schema

1 status code documented

200SuccessPaginated list of product categories.

countnumberRequired

Total number of categories matching the filter.

itemsobject[]Required

Array of category items.

Each array item:

idstringRequired

Category code.

namestringRequired

Display name.

slugstringRequired

URL-friendly slug.

Response example

application/json

{
  "count": 0,
  "items": [
    {
      "id": "example_id",
      "name": "example_name",
      "slug": "example_slug"
    }
  ]
}

Request example

GET /api/v1/product-category/list

get

curl -X GET "https://api.bizkithub.com/api/v1/product-category/list?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE&parentSlug=example_parentSlug" \
  -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