BizKitHub
DocsAPI ReferenceIssue/bff/issue/comments
getIssueAdmin BFF

/bff/issue/comments

Returns a paginated list of comments for a specific issue, ordered by creation date (oldest first).

IssuegetBffIssueComments

Parameters

3 query

Query parameters

· 3
issueKeystringRequired

Issue key.

ExamplePROJ-123
pagenumberOptional

Page number.

Default: 1
Example1
limitnumberOptional

Items per page.

Default: 100
Example100

Response schema

1 status code documented

200Success
itemsobject[]Required
Each array item:
idstringRequired

Comment ID (format: "PROJ-123_c456").

authorIdnumberRequired

Author contact ID (FK; not necessarily who the UI shows for ai/system).

authorKind"human" | "ai" | "system"Required

Who wrote the comment. human = staff / reporter, ai = AI Agent (authorName is rewritten server-side to "AI Agent" and authorEmail is empty), system = workflow / audit.

channel"internal" | "email_out" | "email_in"Required

Timeline channel: internal = staff-only note (no e-mail was sent), email_out = comment sent to the customer as an e-mail, email_in = inbound customer reply lifted from an e-mail or the public support portal.

authorNamestringRequired

Ready-to-render display name. For ai/system this is a synthetic label ("AI Agent" / "System"), NOT the FK contact's name.

authorEmailstringRequired

Author email — empty string for ai/system comments.

messagestringRequired

Comment text.

insertedDateDate | string | string | numberRequired

When the comment was created.

One of 4:
Variant 1
Date

When the comment was created.

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

Last update.

One of 4:
Variant 1
Date

Last update.

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

True when the LLM classifier flagged this comment as spam at insert time. Populated on public-portal replies (channel = email_in) — inbound e-mails, staff notes, and AI/system entries always report false.

spamReasonstring | nullRequired

Short human-readable reason from the classifier (≤200 chars). Null for non-spam rows or when the classifier declined to explain. Render as the tooltip on the spam badge — never surface to the customer.

One of 2:
Variant 1
string
Variant 2
null
itemCountnumberRequired

Total comment count.

Response example

application/json
{
  "items": [
    {
      "id": "example_id",
      "authorId": 0,
      "authorName": "example_authorName",
      "authorEmail": "example_authorEmail",
      "message": "example_message",
      "isSpam": false
    }
  ],
  "itemCount": 0
}

Request example

GET /bff/issue/comments

get
curl -X GET "https://api.bizkithub.com/bff/issue/comments?issueKey=PROJ-123&page=1&limit=100" \
  -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