API Versioning Policy

Version 1.0  ·  Effective 2026-04-22

The current API version is v1. All routes are prefixed /v1/.

Lifecycle States

• Current: No warnings. Fully supported.
• Deprecated: X-API-Deprecated: true and X-API-Sunset-Date headers are present. Minimum 180-day notice.
• Sunset: Returns 410 Gone.

What To Expect

Breaking changes are introduced in a new API version instead of silently changing existing behavior. Deprecated versions continue to work during the notice window so you have time to migrate safely.

Migration Guidance

Watch response headers for deprecation notices, update your integration to the current version, and test against the replacement endpoint before the sunset date.

See Changelog for release history.