BizKitHub Developer Documentation

Parameters

1 path · 1 query

Path parameters

· 1

externalIdstringRequired

The 16-char alphanumeric external identifier of the issue (from BKH-ISSUE token).

Length: 16–16

Examplea1B2c3D4e5F6g7H8

Query parameters

· 1

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

Response schema

1 status code documented

200Success

object | object

One of 2:

Variant 1

success"true"Required

issueobjectRequired

externalIdstringRequired

issueKeystringRequired

subjectstringRequired

descriptionstringRequired

statusCategoryCode"new" | "progress" | "waiting" | "done"Required

statusLabelstringRequired

prioritynumber | nullRequired

One of 2:

Variant 1

number

Variant 2

null

insertedDatestringRequired

localestringRequired

organisationNamestringRequired

organisationLogostring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

reporterobjectRequired

emailstring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

displayNamestringRequired

commentsobject[]Required

Each array item:

idstringRequired

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

authorDisplayNamestringRequired

insertedDatestringRequired

messagestringRequired

isSpambooleanRequired

True when the comment was classified as spam by isSpam() at insert time. The row is still stored (moderator can audit false positives); the UI renders a red badge next to the author name and skips outbound customer notifications.

attachmentsobject[]Required

Files uploaded together with the original issue. Empty when none.

Each array item:

tokenstringRequired

Opaque blob token, safe to embed in the public URL.

filenamestringRequired

sizenumberRequired

File size in bytes.

contentTypestringRequired

downloadUrlstringRequired

Signed direct-download URL.

Variant 2

success"false"Required

error"NOT_FOUND" | "INVALID_EXTERNAL_ID"Required

Response example

application/json

{
  "success": true,
  "issue": {
    "externalId": "example_externalId",
    "issueKey": "example_issueKey",
    "subject": "example_subject",
    "description": "example_description",
    "statusLabel": "example_statusLabel",
    "insertedDate": "example_insertedDate",
    "locale": "example_locale",
    "organisationName": "example_organisationName",
    "reporter": {
      "displayName": "example_displayName"
    },
    "comments": [
      {
        "id": "example_id",
        "authorDisplayName": "example_authorDisplayName",
        "insertedDate": "example_insertedDate",
        "message": "example_message",
        "isSpam": false
      }
    ],
    "attachments": [
      {
        "token": "example_token",
        "filename": "example_filename",
        "size": 0,
        "contentType": "example_contentType",
        "downloadUrl": "example_downloadUrl"
      }
    ]
  }
}

/api/v1/support/issue/{externalId}

Parameters

Path parameters

Query parameters

Response schema

Response example

Request example

Need an API key?