API reference
The wrk!ng REST API is documented as an OpenAPI 3 specification that the interactive reference below loads directly from the running server. Authenticate with a Bearer token to use Try it out on any endpoint.
Top-level endpoint families
Every resource lives under /api/<resource> and shares the same five-verb
shape (GET list, GET detail, POST, PATCH,
DELETE). The families below cover the platform core; installed packs add their
own routes on the same pattern.
| Prefix | Purpose |
|---|---|
/api/auth/* | Login, logout, MFA, password reset, invite acceptance, token refresh |
/api/organizations/* | Org CRUD, settings, addresses, and unified contacts (email, phone, website, fax, social profiles) |
/api/users/* | User CRUD, avatars, preferences, identity documents, relationships |
/api/employees/* | Employee CRUD, lifecycle events, onboarding state |
/api/teams/* | Team CRUD and hierarchy |
/api/positions/* | Job description CRUD |
/api/addresses/* | Canonical postal addresses — see Addresses |
/api/workflows/* | Workflow CRUD, clone, publish, embed tokens |
/api/steps/* · /api/elements/* · /api/element-collections/* | Form engine internals |
/api/tasks/* | Task CRUD, kanban moves, threaded comments — see Tasks |
/api/packs/* | Pack catalog, install, uninstall, settings, upgrade |
/api/audit/* · /api/events/* | Audit log reads and lifecycle event stream |
For the full list, including all response schemas, query parameters, and per-endpoint permissions, use the interactive reference below.