BizKitHub
DocsAPI ReferenceSupport/api/v1/support/my-issue-detail
getSupportPublic API v1

/api/v1/support/my-issue-detail

Same shape as GET /support/issue/{externalId} (customer-visible thread without spam) plus branchSlug, assignedToMe, lastCommentId, securedTicket and channel on every comment. Internal notes (channel = internal) are included only for a ticket assigned to the caller, and only those written by people (never AI / system entries). The reporter's IP address is never included.

Access rule ISSUE_ACCESS (evaluated on every call): the caller is the contact behind identityId in the organisation of apiKey. A ticket is accessible when it belongs to that organisation, is classified as not spam, and

  • A (assignment): it is assigned to the caller's contact (also confidential tickets), or
  • B (branch): its branch is an active branch the caller operates (shop__branch_person role technician, manager or owner), the ticket is not confidential (securedTicket / hidden from the branch) and it was not handed back to the head office.

There is no owner (root) shortcut and contact groups (fransiza, trainer, …) never grant access. An inaccessible and a non-existent externalId answer the same 403 ISSUE_FORBIDDEN. A missing or invalid identityId answers 401.

supportgetApiV1SupportMy-issue-detail

Parameters

3 query

Query parameters

· 3
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
identityIdstringOptional

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

ExampleZ9CPkS2o3UV163VQn5OUv0T8BQi8Fvdg
externalIdstringRequired

Opaque 16-char ticket id (externalId from /support/my-issue-list).

Length: 1–32
ExampleQr0MZ0vYnp8xMYgs

Response schema

2 status codes documented

200Success
success"true"Required
issueobjectRequired
externalIdstringRequired
issueKeystringRequired
subjectstringRequired
descriptionstringRequired

Sanitised HTML.

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

Newest first, at most 100.

Each array item:
idstringRequired
ExampleGYMRO-844_c1267
authorKind"human" | "ai" | "system"Required
authorDisplayNamestringRequired
channel"internal" | "email_out" | "email_in"Required

email_out = reply sent to the customer, email_in = message from the customer, internal = staff note.

insertedDatestringRequired
messagestringRequired

Sanitised HTML.

attachmentsobject[]Required
Each array item:
tokenstringRequired
filenamestringRequired
sizenumberRequired
contentTypestringRequired
downloadUrlstringRequired

Signed direct-download URL. Fetch fresh, do not cache.

branchSlugstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
assignedToMebooleanRequired
lastCommentIdstring | nullRequired

Last customer-visible comment; send it back with /my-issue-reply.

One of 2:
Variant 1
string
Variant 2
null
securedTicketbooleanRequired

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": "GYMRO-844_c1267",
        "authorDisplayName": "example_authorDisplayName",
        "insertedDate": "example_insertedDate",
        "message": "example_message"
      }
    ],
    "attachments": [
      {
        "token": "example_token",
        "filename": "example_filename",
        "size": 0,
        "contentType": "example_contentType",
        "downloadUrl": "example_downloadUrl"
      }
    ],
    "assignedToMe": false,
    "securedTicket": false
  }
}

All documented status codes

· 2

Request example

GET /api/v1/support/my-issue-detail

get
curl -X GET "https://api.bizkithub.com/api/v1/support/my-issue-detail?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE&identityId=Z9CPkS2o3UV163VQn5OUv0T8BQi8Fvdg&externalId=Qr0MZ0vYnp8xMYgs" \
  -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