Developers
A small API, described accurately.
Everything this page does not list does not exist, which is the part of an API page that usually costs somebody a week.
Reference
The whole of the v1 surface
Eight resources over REST, and an OpenAPI document you can generate a client from.
| Path | What it is |
|---|---|
/api/v1/people | The directory: a person with their role, department and manager. |
/api/v1/tasks | Work items, with their status, owner, dates and links. |
/api/v1/sops | Processes, with their kind, version and acknowledgement state. |
/api/v1/kras | Result areas, with their weight and the role that owns them. |
/api/v1/kpis | Measures, with their target, unit and direction. |
/api/v1/kpi-records | Readings against a period. This is the write path for a measure. |
/api/v1/kudos | Recognitions, with the value each one names. |
/api/v1/openapi.json | The OpenAPI 3.1 document for everything above, generated from the running app. |
Read the OpenAPI document. Keys are created in workspace settings by an admin.
Limits
What to design around.
- Keys, with three scopesRead, write and admin. A key is shown once at creation and stored only as a hash, with the first twelve characters kept so you can tell two keys apart in a list.
- Rate limits you can read120 requests a minute and 50,000 a day per key by default, counted in fixed calendar minute and calendar day buckets, so a burst can straddle a boundary. They are per key and adjustable, not a plan tier.
- A signed webhook, on some eventsAn outbound POST with an HMAC signature header, on a handful of events including a review finalising, a process changing and an invitation going out. It is not an event bus over every entity.
- CSV, both directionsImport into a table from a spreadsheet, and export activity, compliance, people, reviews and the whole of your own data.
- No GraphQLThere is no GraphQL endpoint. If you need one, say so and it goes on the roadmap where you can see it.
- No published SDKsThere is no client library in any language. Generate one from the OpenAPI document, which is the reason that document is served.
Building something and hitting an edge? Write to hello@workwrk.com.