Introduction to the Worklix API
The Worklix API lets your server-side applications read and manage selected workforce resources so you can connect Worklix to reporting, operations and internal business workflows.
Do not expose production tokens in browser code, public repositories or shared client-side configuration.
Authentication
Use a Worklix API token in the Authorization header for each request. Tokens identify the workspace and permissions available to the integration.
Authorization: Bearer wl_live_your_token_here
Accept: application/json
Content-Type: application/jsonBase URL
All examples in these guides use the versioned Worklix API base URL. Keep the version in your integration configuration so upgrades can be reviewed deliberately.
https://api.worklix.com/v1/Response format
Worklix endpoints return JSON. Successful list endpoints may include pagination metadata, while resource endpoints return a single object or action result.
{
"data": { ... },
"meta": { "request_id": "req_01J..." }
}Common HTTP responses
Handle authentication, validation, missing records and temporary service failures explicitly instead of treating every non-200 response the same.
- 200 / 201 — request succeeded.
- 400 — request parameters or body are invalid.
- 401 / 403 — authentication or permission scope is insufficient.
- 404 — requested resource was not found.
- 429 — request volume exceeded the current limit.
- 5xx — retry only with safe backoff logic.