BizKitHub
DocsAPI ReferencePost/api/v1/post/category-tree
getPostPublic API v1

/api/v1/post/category-tree

Returns the full active category tree for the caller organisation, one node per category, with recursive postCount (sum of the node and all descendants) already computed by the server. Payload intentionally omits post content — use /api/v1/post/category?slug=… to fetch the articles listed under a specific category. Inactive and unrouted categories are stripped so the response is safe to render directly as a navigation sidebar.

postgetApiV1PostCategory-tree

Parameters

2 query

2 total
Query · 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

localestring

Communication locale code — controls the language of textual data (product names, descriptions, articles, storefront UI, transactional e-mails).

Preferred format: BCP 47 language tag — language[-Script][-REGION]. Use the full tag whenever the script or region matters:

  • en-GB vs. en-US (British vs. American spelling)
  • pt-PT vs. pt-BR (European vs. Brazilian Portuguese)
  • zh-Hans vs. zh-Hant (Simplified vs. Traditional Chinese)
  • sr-Latn vs. sr-Cyrl (Latin vs. Cyrillic Serbian)

Backwards-compatible fallback: the bare two-letter ISO 639-1 code (cs, en, pl, …) is accepted indefinitely — legacy clients that only send the language subtag continue to work unchanged.

Resolution algorithm (server-side): the input is resolved against the supported locale list via the [RFC 4647 Lookup] progressive-fallback strategy — trailing subtags are stripped one by one until a supported locale is found. Example: en-GB-oxendicten-GBen (matched). If no subtag combination is supported, the request is rejected.

Currently supported locales: cs, en, fr, it, pl, de, sk, sv, es, zh, ja, uk, da, hu, ro, nl, pt, fi, nb, hr. Region-specific variants (e.g. en-GB, pt-BR) are accepted and resolved to their base language when the exact variant is not registered separately.

Length: 235

Request

GET /api/v1/post/category-tree

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

Response

JSON payload

{
  "items": [
    {
      "id": "Yxadt7Yebzp28n5g",
      "slug": "sales",
      "title": "Sales",
      "active": false,
      "postCount": 9,
      "children": []
    }
  ]
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key