Klockwork API
Call the Klockwork public API with an API key.
The public API is https://api.klockwork.org. Every call starts with /api/public/ and one of four surfaces. The key in the request decides which surface you can use. Each surface page lists the query, the request body, and the response fields.
PHP projects can install the client with Composer. See Installation.
| Surface | Base path | Who the key acts as |
|---|---|---|
| Partner | /api/public/partner | An accepted partner |
| Agency | /api/public/agency | The agency that created the key |
| Solo | /api/public/solo | One active talent of that agency |
| Company | /api/public/company | One linked client company of that agency |
Send the key on every request:
X-Klockwork-Key: kw_...Authorization: Bearer kw_... is accepted when X-Klockwork-Key is absent. The token must start with kw_.
A partner key only works on the partner surface. An agency key works on agency, solo, and company, and is rejected on partner. Creating, listing, and revoking keys is a signed-in workspace action. Those routes are not on the public API.