BizKitHub
DocsAPI ReferenceGlossary/api/v1/glossary/category/list
getGlossaryPublic API v1

/api/v1/glossary/category/list

Returns every active, non-deleted category with its canonical slug in the requested locale and the count of public terms directly assigned. Frontend can arrange into a tree via parentId.

glossarygetApiV1GlossaryCategoryList

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
localestringRequired

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
Examplecs

Response schema

1 status code documented

200Success
itemsobject[]Required
Each array item:
idstringRequired
slugstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
parentIdstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
namestringRequired
descriptionstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
positionnumberRequired
termCountnumberRequired

Response example

application/json
{
  "items": [
    {
      "id": "example_id",
      "name": "example_name",
      "position": 0,
      "termCount": 0
    }
  ]
}

Request example

GET /api/v1/glossary/category/list

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