kapi WorksDocs

Certificates at a moment

GET/v1/certificates

Employee certificates issued by as_at, with their state then. Requires certificates:read. Names, work emails and certificate check codes also need people:read; without it they are left out.

Authorization

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

Query Parameters

as_at?|

RFC 3339 instant with an offset, or a date read as the end of the company's day. 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/certificates'
{  "data": [    {      "deployment_id": "00000000-0000-4000-8000-000000000001",      "organization_id": "4f6b2a52-1c1e-4f7a-9d3e-2b7c8a9e0d11",      "learning_space_id": "8b2d6c3e-5f41-4a8e-9c27-1d0e3f4a5b62",      "certificate_id": "f1b9d3e5-6a2c-4d70-8b4e-5c3a2f1e0d98",      "learner_profile_id": "c3a1e7f2-8d64-4b1f-a9e2-6f5d4c3b2a10",      "person_name": "Amira Okafor",      "course_id": "d2f8b4a6-7c1e-4e93-b5a0-3c9e8f7d6a21",      "course_release_id": "e5c2a9d7-4b3f-4c18-9a6e-2f1d0c9b8a77",      "course_release_version": 3,      "certificate_title": "Information security essentials",      "kind": "completion",      "earned_at": "2026-09-12T13:41:09Z",      "issued_at": "2026-09-12T13:41:10Z",      "valid_until": "2027-09-12T13:41:10Z",      "status": "valid",      "changed_at": null,      "changed_by": null,      "supersedes_id": null,      "renews_id": null,      "check_code": "KW7Q4M2X9P",      "live_session_id": null,      "live_session_format": null,      "live_session_starts_at": null,      "live_session_ends_at": null,      "live_session_minutes": null,      "live_session_marked_by": null,      "trainer_name": null    }  ],  "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}

Every training record owed during a period

Every record owed at any time between `from` and `to`, with its outcome at the end of the period or when it ended. Requires `training:read`. Names, work emails and certificate check codes also need `people:read`; without it they are left out.

Employees and invitations during a period

Employees and invitation records that existed between `from` and `to`. Requires `people:read`. Names, work emails and certificate check codes also need `people:read`; without it they are left out.