Skip to content
WorkLogx
Menu· Getting Started

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

Getting Started

Send your first request to the WorkLogx Public API in a few minutes. All examples use the TEST environment (https://api-test.worklogx.com/api) with a wlx_test_ key. Production uses https://api.worklogx.com/api with wlx_live_ keys, see Authentication.

#1. Open WorkLogx

Sign in to the WorkLogx web app with an account that can manage integrations.

#2. Go to Integrations

Open Integrations in the navigation.

#3. Choose WorkLogx API

Select WorkLogx API.

#4. Create an API client

Click Create API access and give it a name that describes the integration, for example "ERP sync".

#5. Select scopes

Under Permissions, select only what the integration needs. Read access uses <resource>:read, create and update use <resource>:write, for example customers:read. See API Keys & Scopes.

#6. Copy the API key once

The API key is shown only once. Copy it and store it in your secret manager. If it is lost, create a new key.

Never put API keys in client-side code, mobile apps or version control.

#7. Send your first request

curl https://api-test.worklogx.com/api/v1/customers \
  -H "Authorization: Bearer wlx_test_YOUR_API_KEY"

The response contains the first page of customers:

{
  "data": [
    {
      "id": "3f2b8c1e-6a4d-4e2f-9b7a-1c5d8e0f2a34",
      "customerNumber": "K-10023",
      "name": "Muster Haustechnik GmbH",
      "active": true,
      "createdAt": "2026-09-14T08:12:45Z",
      "updatedAt": "2026-10-28T15:03:11Z"
    },
    {
      "id": "8a1d4f7c-2b9e-4c3a-a6f1-7e2d9b0c5f18",
      "customerNumber": "K-10024",
      "name": "Beispiel Anlagenbau AG",
      "active": true,
      "createdAt": "2026-09-21T10:40:02Z",
      "updatedAt": "2026-10-30T09:27:55Z"
    }
  ],
  "nextCursor": "eyJpZCI6IjhhMWQ0ZjdjIn0"
}

If nextCursor is set, pass it as cursor to fetch the next page. Use limit to change the page size (default 50, max 100).

#Next steps