kapi WorksDocs

Who owes which policy version

GET/v1/policy-records

Everyone who owed a version of one of the company's policies at as_at, with their state then (signed, to_do or overdue), the due date, and the receipt that settled it. Employees, partners and customers. Requires acknowledgements:read. Names and account emails also need people:read; without it they are left out.

Authorization

bearerAuth acknowledgements:read
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

Scope: acknowledgements:read

Query Parameters

as_at?|

RFC 3339 instant with an offset, or a date read as the end of the company's day. The records as they stood then. Defaults to now.

cursor?string

Opaque next_cursor from the previous page. Send it unchanged to the same endpoint. It pins the snapshot and filters, and grants no access.

limit?integer

Rows per page, 1 to 200. Larger values are treated as 200. A page can hold fewer rows to stay within 3 MiB, so follow next_cursor until it is null.

Range1 <= value
Default200

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/policy-records'
{  "data": [    {      "deployment_id": "00000000-0000-4000-8000-000000000001",      "organization_id": "4f6b2a52-1c1e-4f7a-9d3e-2b7c8a9e0d11",      "learning_space_id": "8b2d6c3e-5f41-4a8e-9c27-1d0e3f4a5b62",      "record_id": "8e6c4a2f-1d3b-5f7e-9a8c-6b4d2f0e1a66",      "course_id": "3e1d5c7b-9a2f-4e6d-8c1b-5a7f9e3d1c22",      "course_release_id": "6f4e2d1c-8b7a-4c9e-9d3f-2e1a0b9c8d33",      "policy_title": "Partner code of conduct",      "version": 2,      "learner_profile_id": "1b3d5f7a-9c2e-4b6d-8f1a-3c5e7b9d2f55",      "person_name": "Tomas Reyes",      "account_email": "tomas.reyes@example.com",      "door": "partner",      "company": "Northwind Logistics",      "assignment_id": "4c2a0e8f-6d4b-4e9c-8b7a-5f3d1c9e7b77",      "state": "signed",      "due_at": "2026-10-15T22:59:59Z",      "signed_at": "2026-10-12T09:14:03.218734Z",      "receipt_id": "2a9c7e5f-3b1d-4f8a-9e6c-4d2b0a8f6e44",      "act": "signed"    }  ],  "total": 1,  "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  },  "next_cursor": null}

Policy versions

Every version of the company's policies published by `as_at`, oldest first, each with its canonical HTML file, its statement and every field its `version_digest` covers, so anyone can check the file and the digest without Kapi. A page holds fewer versions when their files are long. Requires `acknowledgements:read`.

Policy receipts

The company's policy receipts in the order Kapi wrote them, each with the fields its hash covers, so anyone can check `receipt_sha256` and the chain without Kapi. Employees, partners and customers; a signed act carries its `signature_sha256`. Requires `acknowledgements:read`. Names and account emails also need `people:read`; without it they are left out.