Versions
How the API evolves without breaking your integration: the dated version and the Lidmeo-Version header.
The API carries two markers:
/v1in the address: the API's generation. It does not change.- A dated version, today
2026-10-01, in theLidmeo-Versionheader. Every response says the version that answered.
Your version is pinned
An API key keeps the version of the day it was created, so does a webhook endpoint: your integration keeps receiving exactly what it expects, even when a new version comes out. To try another one, send the header on a request:
Lidmeo-Version: 2026-10-01An unknown version answers 400 invalid_api_version. An OAuth connection without the header gets the latest version.
What changes without a new version
Additions arrive without notice, in every version:
- new operations, new optional parameters;
- new fields in responses and events;
- new event types;
- new values in a list of possible values (a new stage, a new error code).
Write your code to tolerate them: ignore a field you don't know, plan a default case for an unknown value, and subscribe your webhooks to precise types rather than * if your code only handles those.
What requires a new version
Removing or renaming a field, changing its type or its meaning, making a parameter mandatory: this only happens in a new dated version, at most twice a year, announced in the changelog. A version stays served at least 18 months; when its end approaches, its responses carry the Deprecation and Sunset headers.