Docs API Reference Glossary/api/v1/glossary/category/detail

getGlossaryPublic API v1

/api/v1/glossary/category/detail

Returns the category metadata (name, description, meta description), its breadcrumb chain up to the root, and a paginated slice of published public terms directly assigned to it. Nested subcategories are not merged in — the frontend obtains them via /category/list filtered by parentId.

glossarygetApiV1GlossaryCategoryDetail

Parameters

5 query

Query parameters

· 5

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-oxendict → en-GB → en (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: 2–35

Examplecs

slugstringRequired

Examplekryptografie

pagestringOptional

1-based page index. Default 1.

Exampleexample_page

limitstringOptional

Items per page. Default 50, max 500.

Exampleexample_limit

Response schema

1 status code documented

200Success

object | object

One of 2:

Variant 1

idstringRequired

slugstringRequired

namestringRequired

descriptionstring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

metaDescriptionstring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

parentobject | nullRequired

One of 2:

Variant 1

idstringRequired

Category public id (16-char).

slugstring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

namestringRequired

Variant 2

null

breadcrumbobject[]Required

Each array item:

idstringRequired

Category public id (16-char).

slugstring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

namestringRequired

termsobject[]Required

Each array item:

idstringRequired

slugstring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

termstringRequired

abbreviationstring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

definitionCountnumberRequired

aliasCountnumberRequired

publishedDateDate | string | string | number | nullRequired

One of 2:

Variant 1

Date | string | string | number

One of 4:

Variant 1

Date

Variant 2

stringdate-time

Variant 3

stringdate

Variant 4

number

Variant 2

null

updatedDateDate | string | string | numberRequired

One of 4:

Variant 1

Date

Variant 2

stringdate-time

Variant 3

stringdate

Variant 4

number

termCountnumberRequired

Variant 2

state"error"Required

messagestringRequired

code"200"Required

hintstring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

Response example

application/json

{
  "id": "example_id",
  "slug": "example_slug",
  "name": "example_name",
  "breadcrumb": [
    {
      "id": "example_id",
      "name": "example_name"
    }
  ],
  "terms": [
    {
      "id": "example_id",
      "term": "example_term",
      "definitionCount": 0,
      "aliasCount": 0
    }
  ],
  "termCount": 0
}

Request example

GET /api/v1/glossary/category/detail

get

curl -X GET "https://api.bizkithub.com/api/v1/glossary/category/detail?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE&locale=cs&slug=kryptografie&page=example_page&limit=example_limit" \
  -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