API Versioning

Livingdocs uses date-based API versioning. A new API version ships every odd month (January, March, May, July, September, November) alongside each Livingdocs release.

The version appears directly in the URL path:

https://server.livingdocs.io/api/2026-01/documents/latestPublications

Support Window

Each version is supported for a minimum of two years. Not every version introduces breaking changes — many releases are fully compatible with previous versions.

When a version reaches end of life, requests return a 410 Gone response. See Common Errors for details.

Upgrading Between Versions

Since many releases are fully compatible, you can often skip ahead multiple versions without any code changes. Each endpoint's detail page includes a History section that lists the changes introduced in each release. To check whether you can upgrade directly from e.g. 2025-07 to 2026-01, review the history of the endpoints you use. If none of them have breaking changes in between, you can update the version in your URL and you're done.

We recommend keeping your integration on a recent version to benefit from improvements and to avoid running into the end-of-life window under time pressure.

Tracking Deprecated Usage

The Livingdocs Editor shows deprecated endpoint usage per API token. In Api Clients under project settings, you can see at a glance which tokens are calling deprecated endpoints and need attention. This is one of the reasons we recommend creating a separate token for each application.

Deprecations

Parts of the API can be deprecated if they become unnecessary, unsafe, or outdated. Deprecations are announced in the changelog at minimum six months before removal.

Common reasons for deprecation:

• Breaking change in a newer version — The older variant remains available within its support window. For example, if /api/2025-03/publications/search receives a breaking change in 2025-05, the 2025-03 variant is deprecated and removed with the regular support window in 2027-05.
• End of life — An API version reaches the end of its two-year support window. All endpoints in that version are deprecated six months before removal.
• Feature removal — A specific endpoint is no longer needed because the underlying functionality was removed from Livingdocs. Announced six months before removal in the changelog.