WorkLogx Public API
The WorkLogx Public API gives your systems programmatic access to the data of your WorkLogx organization: employees, customers, projects, tasks, forms, submissions, absences and worklogs. Typical uses are syncing master data from an ERP or CRM and exporting recorded work into payroll or invoicing.
#At a glance
| Base URL | TEST https://api-test.worklogx.com/api, production https://api.worklogx.com/api |
| Version | v1, all paths start with /v1/ |
| Format | JSON over HTTPS |
| Authentication | API key as Bearer token |
| Pagination | Opaque cursor, limit default 50, max 100 |
| Writes | POST requires an Idempotency-Key header |
#Resources in V1
| Resource | Read | Create / update |
|---|---|---|
| Employees | GET /v1/employees, GET /v1/employees/{id} | POST, PATCH |
| Customers | GET /v1/customers, GET /v1/customers/{id} | POST, PATCH |
| Projects | GET /v1/projects, GET /v1/projects/{id} | POST, PATCH |
| Tasks | GET /v1/tasks, GET /v1/tasks/{id} | POST, PATCH |
| Absences | GET /v1/absences, GET /v1/absences/{id} | POST, PATCH |
| Forms | GET /v1/forms, GET /v1/forms/{id} | read only |
| Submissions | GET /v1/submissions, GET /v1/submissions/{id} | read only |
| Worklogs | GET /v1/worklogs, GET /v1/worklogs/{id} | read only |
Every request is scoped to the organization that owns the API key. Each operation requires a scope such as customers:read or customers:write; the API reference lists the scope for every endpoint.
#Authentication
Send your API key in the Authorization header:
Authorization: Bearer wlx_test_<prefix>_<secret>Keys starting with wlx_test_ belong to the test environment, keys starting with wlx_live_ to production. Each environment only accepts its own keys. Keep keys secret and only use them server-side. Details: Authentication.
#Next steps
- Getting Started: create an API client and send your first request.
- API Reference: all V1 endpoints with parameters, schemas and examples.