BizKitHub
DocsAPI ReferencePost/bff/post/detail
getPostAdmin BFF

/bff/post/detail

Returns full post detail including title, content, visibility, authors, and available translations. Content is returned in the default locale (or first available translation).

PostgetBffPostDetail

Parameters

2 query

Query parameters

· 2
idstringRequired

Post external ID.

ExampleaBcDeFgH12345678
localestringOptional

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
idstringRequired

Post external ID.

titlestringRequired

Post title.

contentstringRequired

Post content (HTML).

perexstringRequired

Short summary/teaser of the post.

metaTitlestringRequired

SEO <title> for the displayed locale. Empty string when not set.

metaDescriptionstringRequired

SEO <meta description> for the displayed locale. Empty string when not set.

visibility"public" | "private" | "unlisted" | "subscribe"Required

Post visibility level.

status"draft" | "scheduled" | "published" | "private" | "archived"Required

Computed publication status (draft/scheduled/published/private/archived).

mainCategoryIdstringOptional

External ID of the main category.

authorIdsstring[]Required

Ordered list of author IDs. First is the main author.

Author external ID (customer/contact CU reference).

isStarbooleanRequired

Whether the post is starred/featured.

publishedDateDate | string | string | numberOptional

Date when the post was published.

One of 4:
Variant 1
Date

Date when the post was published.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
insertedDateDate | string | string | numberRequired

Date when the post was created.

One of 4:
Variant 1
Date

Date when the post was created.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
updatedDateDate | string | string | numberRequired

Date when the post was last updated.

One of 4:
Variant 1
Date

Date when the post was last updated.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
wordCountnumberRequired

Approximate word count of the displayed locale's content.

readingTimeMinutesnumberRequired

Approximate reading time in minutes (200 wpm). 0 when the post has no content.

translatedLocalesstring[]Required

Locales for which a translation exists in content__post_locale.

Locale code (e.g. "cs", "en").

staleLocalesstring[]Required

Subset of translatedLocales whose source_history_id no longer matches the newest source-locale history entry (or is NULL / legacy). The admin post-detail auto-translate button surfaces this so a manual refresh regenerates each out-of-date locale.

Locale code that is out of date.

viewsCountnumberRequired

Cumulative number of times the post was served by /api/v1/post. Buffered and flushed into content__post.views_count every 5 min, so values may briefly lag.

attachmentsobject[]Required

Files attached to the post (separate from the gallery). Newest first.

Each array item:
idnumberRequired

Attachment row id (used by /post-attachment-delete).

filenamestringRequired

Original filename.

downloadUrlstringRequired

Public download URL on blob storage.

sizenumberRequired

File size in bytes.

contentTypestringRequired

MIME content type.

insertedDateDate | string | string | numberRequired

When the file was attached.

One of 4:
Variant 1
Date

When the file was attached.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number

Response example

application/json
{
  "id": "example_id",
  "title": "example_title",
  "content": "example_content",
  "perex": "example_perex",
  "metaTitle": "example_metaTitle",
  "metaDescription": "example_metaDescription",
  "mainCategoryId": "example_mainCategoryId",
  "authorIds": [
    "string"
  ],
  "isStar": false,
  "wordCount": 0,
  "readingTimeMinutes": 0,
  "translatedLocales": [
    "string"
  ],
  "staleLocales": [
    "string"
  ],
  "viewsCount": 0,
  "attachments": [
    {
      "id": 0,
      "filename": "example_filename",
      "downloadUrl": "example_downloadUrl",
      "size": 0,
      "contentType": "example_contentType"
    }
  ]
}

Request example

GET /bff/post/detail

get
curl -X GET "https://api.bizkithub.com/bff/post/detail?id=aBcDeFgH12345678&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