Getting Started
From zero to your first API response in under five minutes.
1
Create an API key
Log in to your LUXPOS dashboard and navigate to Settings → API Keys. The direct link is:
url
https://luxpos.lu/en/dashboard/api-keysClick Create key, give it a descriptive name (e.g. my-integration), select the scopes you need, and copy the generated key. You will only see the full value once.
Keep your key secret. Treat it like a password. Never commit it to version control or expose it in client-side JavaScript.
2
Make your first request
Pass your key in the Authorization header as a Bearer token:
bash
curl -H "Authorization: Bearer lpk_live_..." \
https://api.luxpos.lu/api/v1/public/meA successful response returns the business profile associated with your API key, including the business ID you will reference in other endpoints.
3
Pagination
List endpoints are paginated using cursor-style query parameters:
| Parameter | Type | Description |
|---|---|---|
| page | integer | 1-based page number. Default: 1 |
| limit | integer | Results per page. Default: 50, max: 100 |
bash
# Second page, 20 results per page
curl -H "Authorization: Bearer lpk_live_..." \
"https://api.luxpos.lu/api/v1/public/transactions?page=2&limit=20"The response includes a meta object with total, page, and lastPage fields.
4
Error envelope
All error responses use a consistent JSON envelope:
json
{
"statusCode": 401,
"message": "Unauthorized: missing or invalid API key",
"error": "Unauthorized"
}| Field | Type | Description |
|---|---|---|
| statusCode | integer | HTTP status code |
| message | string | Human-readable error description |
| error | string | Short error class (e.g. "Not Found") |