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

/api/v1/support/my-issue-list

Tickets of the caller's branches plus tickets assigned to the caller. Sorted: waiting for a reply first, then by last activity (newest first). A caller without branch and assignment gets 200 with items: [].

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-list

Parameters

8 query

Query parameters

· 8
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
statusCategoryCodestring | string[]Optional

Status category filter: new, progress, waiting, done. Repeat the parameter or pass a comma-separated list. Default: all.

Examplenew,progress
closedSinceDaysstring | integerOptional

Tickets in category done are listed only when their last activity is at most this many days old. 0 = no closed tickets.

Range: 0–90Default: 14
Example14
pagestring | integerOptional
Range: 1–∞Default: 1
Example1
limitstring | integerOptional
Range: 1–100Default: 50
Example50
localestringOptional

Language of statusLabel. Default: the ticket language, then the organisation language.

Length: 0–5
Examplecs
branchSlugstringOptional

Only tickets of this branch. A branch the caller does not operate simply yields an empty list.

Length: 0–255
Exampleplzen-skvrnany

Response schema

1 status code documented

200Success
success"true"Required
itemCountnumberRequired

Total number of matching tickets (all pages).

itemsobject[]Required
Each array item:
externalIdstringRequired
ExampleQr0MZ0vYnp8xMYgs
issueKeystringRequired
ExampleGYMRO-844
subjectstringRequired
previewstringRequired

First ~220 characters of the description as plain text (no HTML, no markdown).

statusCategoryCode"new" | "progress" | "waiting" | "done"Required
statusLabelstringRequired
ExampleNový
branchSlugstring | nullRequired
One of 2:
Variant 1
string
Variant 2
null
reporterDisplayNamestringRequired
ExampleJana Nováková
assignedToMebooleanRequired

Accessible through rule A (assigned to the caller).

waitsForReplybooleanRequired

Not done and the last customer-visible message (description, inbound mail, portal reply) is from the customer.

lastCommentIdstring | nullRequired

Id of the last customer-visible comment (ISSUEKEY_c<n>), null when there is none. Pass it to /my-issue-reply.

One of 2:
Variant 1
string
Variant 2
null
insertedDatestringRequired

ISO timestamp.

lastActivityDatestringRequired

ISO timestamp of the last update or customer-visible message.

Response example

application/json
{
  "success": true,
  "itemCount": 0,
  "items": [
    {
      "externalId": "Qr0MZ0vYnp8xMYgs",
      "issueKey": "GYMRO-844",
      "subject": "example_subject",
      "preview": "example_preview",
      "statusLabel": "Nový",
      "branchSlug": "plzen-skvrnany",
      "reporterDisplayName": "Jana Nováková",
      "assignedToMe": false,
      "waitsForReply": false,
      "lastCommentId": "GYMRO-844_c1267",
      "insertedDate": "example_insertedDate",
      "lastActivityDate": "example_lastActivityDate"
    }
  ]
}

Request example

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

get
curl -X GET "https://api.bizkithub.com/api/v1/support/my-issue-list?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE&identityId=Z9CPkS2o3UV163VQn5OUv0T8BQi8Fvdg&statusCategoryCode=new%2Cprogress&closedSinceDays=14&page=1&limit=50&locale=cs&branchSlug=plzen-skvrnany" \
  -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