BizKitHub
DocsAPI ReferenceDocs/api/v1/docs/system-log-code-list
getDocsPublic API v1

/api/v1/docs/system-log-code-list

Returns every system log code registered in core__system_log_code with its title and description. Powers docs.bizkithub.com/system-codes — the public reference for codes like TTL_003, INTERNAL_FIO_API, MBR_NOTE_MENT that appear in technical-notification e-mails and in the admin log viewer. Operational statistics (occurrence counts, first/last-seen timestamps, severity history) are intentionally not exposed here so the public docs do not disclose platform scale; those live behind the admin BFF instead.

docsgetApiV1DocsSystem-log-code-list

Parameters

No parameters required

This endpoint takes no path, query, header or body parameters.

Response schema

1 status code documented

200SuccessSystem log code reference.
itemsobject[]Required
Each array item:
codestringRequired

System log code identifier (max 64 chars).

ExamplesTTL_003INTERNAL_FIO_API_UNAVAILABLE
titlestring | nullRequired

Human-readable title. null when the code has not been documented yet.

One of 2:
Variant 1
string
Variant 2
null
descriptionstring | nullRequired

Detailed explanation. null when the code has not been documented yet.

One of 2:
Variant 1
string
Variant 2
null
modulestringRequired

Module prefix (segment before the first underscore).

ExamplesEMLPAYSHIPM
moduleDescriptionstring | nullRequired

One-line description of the module, null when the prefix is not registered.

One of 2:
Variant 1
string
Variant 2
null
severity"info" | "warning" | "error" | "critical" | nullRequired

How serious the event is. Mirrors the level the code is normally logged with.

One of 5:
Variant 1
"info"
Variant 2
"warning"
Variant 3
"error"
Variant 4
"critical"
Variant 5
null
impact"none" | "operator" | "customer" | nullRequired

Who is affected: none (bookkeeping only), operator (organisation staff), customer (end customers).

One of 4:
Variant 1
"none"
Variant 2
"operator"
Variant 3
"customer"
Variant 4
null
retry"auto" | "manual" | "none" | nullRequired

auto = the platform retries on its own, manual = safe for an operator to retry, none = retrying will not help until the cause is fixed.

One of 4:
Variant 1
"auto"
Variant 2
"manual"
Variant 3
"none"
Variant 4
null
causesstring[]Required

Typical reasons the code is logged.

resolutionstring[]Required

Ordered steps to resolve or verify the situation.

relatedstring[]Required

Other system log codes worth reading alongside.

Response example

application/json
{
  "items": [
    {
      "code": "TTL_003",
      "module": "EML",
      "causes": [
        "string"
      ],
      "resolution": [
        "string"
      ],
      "related": [
        "string"
      ]
    }
  ]
}

Request example

GET /api/v1/docs/system-log-code-list

get
curl -X GET "https://api.bizkithub.com/api/v1/docs/system-log-code-list" \
  -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