kapi WorksDocs

Check whether anything changed

GET/v1/snapshot

Returns the company's latest snapshot in one call, with any scope. If sequence and capture_sequence match your last complete pull, no recorded facts have changed since. Outcomes that depend on the clock, such as not_due_yet becoming overdue, can still change, so recompute them from due_at or pull again at least daily.

Authorization

bearerAuth
AuthorizationBearer <token>

A company API key, not an OAuth access token: kw_live_ in production, kw_test_ elsewhere. Send it only in the Authorization header. A key sent in a URL is revoked.

In: header

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

# Supply the key from your server's secret manager. Do not log it.# curl reads the header from stdin, keeping the key out of its arguments.printf 'header = "Authorization: Bearer %s"\n' "$KAPI_WORKS_API_KEY" |  curl --config - --silent --show-error --fail-with-body \  'https://example.com/v1/snapshot'
{  "snapshot": {    "organization_id": "4f6b2a52-1c1e-4f7a-9d3e-2b7c8a9e0d11",    "deployment_id": "00000000-0000-4000-8000-000000000001",    "as_at": "2026-10-09T09:00:00Z",    "from": null,    "known_at": "2026-10-09T08:59:41Z",    "sequence": 1284,    "capture_sequence": 352,    "chain_hash": "3f9a1c7e5b2d8f4a6c0e9b1d3f5a7c9e2b4d6f8a0c1e3b5d7f9a2c4e6b8d0f1a",    "logic": {      "version": 4,      "date": "2026-10-06"    },    "history_complete_from": "2026-10-06T05:00:00Z",    "available": true  }}

Course versions referenced by employee records

The published course versions behind employee training records, with their content fingerprints. Requires `training:read`. Names, work emails and certificate check codes also need `people:read`; without it they are left out.

Field dictionary

What every field of every register means, from the same dictionary as the records packs.