We’ve made a documentation-only update to our OpenAPI specification to bring it in line with the server versioning model already in use. There is no impact on the API behavior, and no changes are required from your side.
✅ What has been updated?
We updated the OpenAPI spec version from 2.1.0 to 1.0.0
This change aligns the documentation version with our current server URL:
/v1/No functional or structural changes were made to the API
This is purely to improve clarity, reduce confusion, and align on versioning principles
🔍 Why It Matters
This update sets the foundation for consistent versioning and clearer change tracking across our API suite. It also avoids versioning confusion between documentation and server path.
🔁 Going Forward: Our Versioning Policy
The OpenAPI spec will now follow Semantic Versioning 2.0.0
The server path (
/v1/) will remain unchanged unless we introduce breaking changesIf breaking changes do occur, we’ll:
Notify you in advance
Increment the server path (e.g., move to
/v2/)Update the OpenAPI version accordingly
All non-breaking updates (e.g., new fields, docs updates) will not change the server path
📘 Introducing Our Public Changelog
To support greater transparency, we now maintain a changelog for our API specification. This makes it easier for your teams to track updates over time and understand what’s changed at a glance.
❓Do I Need to Do Anything?
No action is required. Your integrations will continue to work as expected under the /v1/ endpoint.
If you have any questions or feedback, feel free to contact our team, we’re always happy to help.