Kapi Works API
Read a company's employee training records, deadlines, completions and certificates from your own server.
- Base URL
https://api.kapiworks.com/v1- Contract
- OpenAPI 3.1.0, revision 1.2.0. Download
- Access
- Company API keys, from your server. Read-only.
Make your first call
- A company owner or admin creates a key in Works Studio, under Settings → API keys.
- You store it in your server's secret manager as
KAPI_WORKS_API_KEY. - Your server reads the first page of training records. Every page of one pull comes from the same snapshot of the company's records.
The Quickstart walks through each step.
# 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://api.kapiworks.com/v1/training-records?limit=200'What you can read
| Endpoint | Returns | Scope |
|---|---|---|
GET /v1/training-records | Training records at a moment | training:read |
GET /v1/training-records/period | Every training record owed during a period | training:read |
GET /v1/certificates | Certificates at a moment | certificates:read |
GET /v1/people | Employees and invitations during a period | people:read |
GET /v1/courses | Course versions referenced by employee records | training:read |
GET /v1/snapshot | Check whether anything changed | Any |
Every call is a GET that answers with JSON. Keys are company keys for your server, not OAuth tokens, and the API sends no CORS headers, so it is for servers rather than browsers.