BizKitHub
DocsAPI ReferencePost/bff/post/comment-list
getPostAdmin BFF

/bff/post/comment-list

Returns a paginated list of comments for the authenticated organisation. Without postId, returns comments across all posts. With postId, scopes to one post. Comments are ordered by inserted date (newest first). Supports standard datagrid pagination via ?page= and ?limit= query params.

PostgetBffPostComment-list

Parameters

2 query

Query parameters

· 2
postIdstringOptional

Optional post external_id. When set, only comments under that post are returned. Used by the post-detail "Comments" tab.

ExampleaBcDeFgH12345678
qstringOptional

Optional fulltext filter — case-insensitive LIKE across comment body, author name and author email. Whitespace-only values are treated as empty. Alternative to the standard datagrid filterFulltextQuery parameter; either wins.

Examplespam

Response schema

1 status code documented

200SuccessPaginated list of comments.
itemsobject[]Required
Each array item:
idstringRequired

Comment ID.

postIdstringRequired

External ID of the post this comment belongs to.

postTitlestringRequired

Title of the post.

authorIdstringRequired

External ID of the comment author (customer/contact).

authorNamestringRequired

Display name of the author.

authorEmailstringRequired

Email of the author.

authorAvatarUrlstring | nullRequired
One of 2:
Variant 1
string

Public URL of the author avatar image, resolved server-side from shop__contact.avatar_blob_id. Null when the contact has no avatar uploaded.

Variant 2
null
contentstringRequired

Comment text content.

insertedDatestringRequired

ISO timestamp when the comment was created.

isDeletedbooleanRequired

Whether the comment has been soft-deleted.

itemCountnumberRequired

Total number of comments matching the query (before pagination).

Response example

application/json
{
  "items": [
    {
      "id": "example_id",
      "postId": "example_postId",
      "postTitle": "example_postTitle",
      "authorId": "example_authorId",
      "authorName": "example_authorName",
      "authorEmail": "example_authorEmail",
      "content": "example_content",
      "insertedDate": "example_insertedDate",
      "isDeleted": false
    }
  ],
  "itemCount": 0
}

Request example

GET /bff/post/comment-list

get
curl -X GET "https://api.bizkithub.com/bff/post/comment-list?postId=aBcDeFgH12345678&q=spam" \
  -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