BizKitHub
DocsAPI ReferenceIssue/bff/issue/related
getIssueAdmin BFF

/bff/issue/related

Returns the issues linked to the given anchor issue via pm__issue_related. Links are stored symmetrically (both directions written on each linkRelatedIssues call), so a single-direction query surfaces every neighbour. Filtered to the callers organisation on BOTH sides (anchor + target) as a defence-in-depth check on top of the write-time same-org invariant. Ordered by link creation time (newest first) and then by internal issue id for stability. The primary today writer is the inbound-mail closed-fork pipeline (reason="mail_closed_issue"`); the admin sidebar renders the list only when non-empty.

IssuegetBffIssueRelated

Parameters

1 query

Query parameters

· 1
issueKeystringRequired

Issue key (e.g. "PROJ-123") whose neighbours to list.

ExamplePROJ-123

Response schema

1 status code documented

200Success
itemsobject[]Required
Each array item:
externalIdstringRequired

Public 16-char identifier of the related issue.

issueKeystringRequired

Human-readable issue key (e.g. "PROJ-123").

subjectstringRequired

Issue subject/title.

prioritynumber | nullRequired
One of 2:
Variant 1
number

Priority (1..5); null when unclassified.

Variant 2
null
statusobjectRequired
idnumberRequired

Status ID.

labelstringRequired

Status display label (localized to the viewing organisation).

categoryIdnumberRequired

Status category ID (1=new, 2=progress, 3=waiting, 4=done).

categoryCodestringRequired

Status category code.

reasonstring | nullRequired
One of 2:
Variant 1
string

Origin of the link. Known values: mail_closed_issue (inbound-mail pipeline forked a fresh ticket because the matched issue was already closed). null for manual links written without a reason.

Variant 2
null
insertedDatestringRequired

When the link was created (UTC timestamp).

itemCountnumberRequired

Number of returned rows (equals items.length).

Response example

application/json
{
  "items": [
    {
      "externalId": "example_externalId",
      "issueKey": "example_issueKey",
      "subject": "example_subject",
      "status": {
        "id": 0,
        "label": "example_label",
        "categoryId": 0,
        "categoryCode": "example_categoryCode"
      },
      "insertedDate": "example_insertedDate"
    }
  ],
  "itemCount": 0
}

Request example

GET /bff/issue/related

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