getPostAdmin BFF

/bff/post/list

Returns a paginated list of posts for the authenticated organisation. Default ordering: starred-first, archived-last, then newest published. Each post includes basic metadata, derived publication status, word count, reading time, main image URL, and associated tags.

PostgetBffPostList

Parameters

9 query

9 total

Query · 9

mainCategoryCodestring

Filter posts by main category code. If not provided, all posts are returned.

localestring

Communication locale code used to filter content.

Supported locales: cs, en, fr, it, pl, de, sk, sv, es, zh, ja, uk, da.

Length: 2–2

statusstring | string | string | string | string

Filter by computed publication status (draft, scheduled, published, private, archived).

visibilitystring | string | string | string

Filter by raw visibility column.

hasMainImagestring

"true" to keep only posts with a main image, "false" to keep only those without.

missingTranslationstring

"true" to keep only posts missing a translation in at least one of the org's configured locales.

tagCodestring

Filter posts by tag code (organisation-scoped). Only posts carrying this tag are returned.

orderBystring

Sort spec <field>:<asc|desc>. Allowed fields: publishedDate, updatedDate, insertedDate, title, wordCount, commentsCount, viewsCount, ratingAverage.

sortBystring

Alias for orderBy (legacy).

Request

GET /bff/post/list

get

curl -X GET "https://api.bizkithub.com/bff/post/list?mainCategoryCode=example_mainCategoryCode&locale=cs&hasMainImage=example_hasMainImage&missingTranslation=example_missingTranslation&tagCode=example_tagCode&orderBy=publishedDate%3Adesc&sortBy=example_sortBy" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

Paginated list of posts with metadata.

{
  "items": [
    {
      "id": "example_id",
      "title": "example_title",
      "mainCategoryId": "example_mainCategoryId",
      "mainCategoryName": "example_mainCategoryName",
      "mainAuthorId": "example_mainAuthorId",
      "mainAuthorName": "example_mainAuthorName",
      "commentsCount": 0,
      "mainImageUrl": "example_mainImageUrl",
      "isStar": false,
      "isDeleted": false,
      "wordCount": 0,
      "readingTimeMinutes": 0,
      "hasPerex": false,
      "tags": [
        {
          "id": 0,
          "name": "example_name",
          "code": "example_code",
          "color": "example_color"
        }
      ],
      "translatedLocales": [
        "string"
      ],
      "viewsCount": 0,
      "ratingAverage": 0,
      "ratingCount": 0
    }
  ],
  "itemCount": 0
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key