BizKitHub
DocsAPI ReferencePost/api/v1/post/comment/list
getPostPublic API v1

/api/v1/post/comment/list

Returns a flat list of comments for a post (no nested structure). Frontend can build parent/child UI using parentId.

postgetApiV1PostCommentList

Parameters

4 query

Query parameters

· 4
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
postIdstringRequired

Post public id (content__post.external_id).

Example6IU2SWgP76FO2UXw
identityIdstringOptional

Logged user identity (from your frontend cookies). Learn more

ExampleZ9CPkS2o3UV163VQn5OUv0T8BQi8Fvdg
includeDeletedbooleanOptional

Internal only. If true, includes deleted comments (deletedDate not null).

Default: false
Examplefalse

Response schema

1 status code documented

200Success
object | object
One of 2:
Variant 1
itemsobject[]Required
Each array item:
idstringRequired

Comment external ID (content__post_comment.external_id), 16-char string.

ExampleAbc1dEf2gHiJ3kL4
parentIdstring | nullRequired
One of 2:
Variant 1
string

Comment external ID (content__post_comment.external_id), 16-char string.

ExampleAbc1dEf2gHiJ3kL4
Variant 2
null
contentstringRequired
insertedDateDate | string | string | numberRequired
One of 4:
Variant 1
Date
Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
deletedDateDate | 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
authorobjectRequired
namestringRequired
profileSlugstringRequired
usingSubscriptionServicebooleanOptional

True if the author is using a subscription service (has active subscription).

isMinebooleanOptional

True if identityId belongs to the comment author.

Variant 2
state"error"Required
messagestringRequired
code"200"Required
hintstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null

Response example

application/json
{
  "items": [
    {
      "id": "Abc1dEf2gHiJ3kL4",
      "content": "example_content",
      "author": {
        "name": "example_name",
        "profileSlug": "example_profileSlug"
      },
      "usingSubscriptionService": false,
      "isMine": false
    }
  ]
}

Request example

GET /api/v1/post/comment/list

get
curl -X GET "https://api.bizkithub.com/api/v1/post/comment/list?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE&postId=6IU2SWgP76FO2UXw&identityId=Z9CPkS2o3UV163VQn5OUv0T8BQi8Fvdg&includeDeleted=false" \
  -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