Skip to content
WorkLogx
Menu· Versioning

Preview: this documentation describes the WorkLogx Public API V1. The V1 rollout to the production environment is not complete yet.

Versioning

The API version is part of the path. All endpoints of the current version start with /v1/:

https://api-test.worklogx.com/api/v1/customers

#What V1 contains

V1 contains 26 operations on eight resources: employees, customers, projects, tasks and absences (list, read, create, update), and forms, submissions and worklogs (list, read). The complete list is in the API Reference.

Anything not listed in the API reference is not part of V1, even if the WorkLogx app offers it.

#Changes

Technical changes to the API are recorded in the API Changelog. The API reference is generated from the OpenAPI specification of the version shown there.

#Recommendations

  • Read responses tolerantly: ignore fields you do not know.
  • Use the code field of errors, not title.
  • Treat cursors as opaque values.