BizKitHub
DocsAPI ReferenceGlossary/api/v1/glossary/detail
getGlossaryPublic API v1

/api/v1/glossary/detail

Returns the full public representation of a glossary term: definitions, aliases, cross references (with resolved target slugs when possible), canonical routes across the organisation locales, and the parent category (if set). Returns an error envelope when the slug does not resolve to a published term.

glossarygetApiV1GlossaryDetail

Parameters

3 query

Query parameters

· 3
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
Exampleaes
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

Response schema

1 status code documented

200Success
object | object
One of 2:
Variant 1
idstringRequired
termstringRequired
abbreviationstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
notesstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
definitionsobject[]Required
Each array item:
textstringRequired

Definition text.

sourcestring | nullRequired
One of 2:
Variant 1
string

Optional attribution or source term.

Variant 2
null
aliasesstring[]Required
crossReferencesobject[]Required
Each array item:
targetTextstringRequired

Free-text pointer as authored.

targetSlugstring | nullRequired
One of 2:
Variant 1
string

Canonical slug of the target term in the same locale, when the text resolved to a known term. Null when unresolved.

Variant 2
null
routeobjectRequired
slugstringRequired
localestringRequired
routesobject[]Required
Each array item:
slugstringRequired
localestringRequired
categoryobject | nullRequired
One of 2:
Variant 1
idstringRequired

Category public id (16-char).

namestringRequired
slugstring | nullRequired
One of 2:
Variant 1
string

Canonical slug in the requested locale, if any.

Variant 2
null
routesobject[]Required

Canonical category routes across all organisation locales.

Each array item:
slugstringRequired
localestringRequired
Variant 2
null
relatedTermsobject[]Required

Up to 50 related terms combining bidirectional cross-references (highest priority) with terms in the same category and sibling-category matches. Empty when the source term has no category assigned.

Each array item:
idstringRequired

Related term public id.

slugstring | nullRequired
One of 2:
Variant 1
string

Canonical slug in the requested locale, if any.

Variant 2
null
termstringRequired
abbreviationstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
categoryobject | nullRequired
One of 2:
Variant 1
slugstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
namestringRequired
Variant 2
null
matchType"cross-reference" | "same-category" | "sibling-category"Required

Signal that qualified this term as related. Cross-references outrank category matches.

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
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",
  "term": "example_term",
  "definitions": [
    {
      "text": "example_text"
    }
  ],
  "aliases": [
    "string"
  ],
  "crossReferences": [
    {
      "targetText": "example_targetText"
    }
  ],
  "route": {
    "slug": "example_slug",
    "locale": "example_locale"
  },
  "routes": [
    {
      "slug": "example_slug",
      "locale": "example_locale"
    }
  ],
  "relatedTerms": [
    {
      "id": "example_id",
      "term": "example_term"
    }
  ]
}

Request example

GET /api/v1/glossary/detail

get
curl -X GET "https://api.bizkithub.com/api/v1/glossary/detail?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE&slug=aes&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