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

/api/v1/product-category/detail

Returns detail of a single product category identified by its URL slug. Returns error PUBLIC_CATEGORY_DOES_NOT_EXIST if the category is deleted, internal, or not found.

productCategorygetApiV1Product-categoryDetail

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

slugstringRequired

URL slug of the product category.

Exampleelectronics

Response schema

1 status code documented

200Success

object | object

One of 2:

Variant 1

Category detail.

idstringRequired

Category code (unique identifier).

Examplecat_electronics

namestringRequired

Display name of the category.

ExampleElectronics

slugstringRequired

URL-friendly slug.

Exampleelectronics

descriptionstringOptional

HTML description formatted for frontend display.

b2bbooleanRequired

Whether the category is B2B-only.

Variant 2

Error response when category does not exist.

statestringRequired

codenumberRequired

messagestringRequired

Response example

application/json

{
  "id": "cat_electronics",
  "name": "Electronics",
  "slug": "electronics",
  "description": "example_description",
  "b2b": false
}

Request example

GET /api/v1/product-category/detail

get

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