API Versioning Support for Public Documentation
Overview
Building stable, future-proof integrations just got easier. We've introduced API Versioning for our public documentation, enabling developers to reliably access and work with specific API versions without worrying about unexpected breaking changes.
What's New
Versioned API Documentation: Each API version now has dedicated documentation for precise reference
Version Switcher: Easily toggle between API versions directly within the documentation
Backward Compatibility: Older API versions remain accessible and fully documented
Why This Matters
- Enables predictable and stable integrations without breaking changes
- Provides smoother upgrade paths to newer API versions
- Improves developer experience with clear, version-specific reference
- Builds confidence for teams managing long-running production systems
Key Highlights
- No impact on existing integrations
- Simplifies API adoption and version migration
- Lays the foundation for structured API evolution and deprecation
- Enhances transparency through version-level visibility
Impact
- Improved reliability and stability for API consumers
- Reduced risk of integration failures during updates
- Faster development and debugging with clear documentation
- Stronger developer ecosystem and long-term scalability
How to Use
Open API documentation → Select the desired version from the version switcher → Reference endpoints and schemas for that version → Build with confidence
Next Step
We're working on the next milestone, v3 of our APIs, which will introduce enhanced capabilities, improved performance, and new endpoints for advanced use cases.
Preview
Select version by switching via toggle at top of the API documentation:
Nudge highlighting user that they are in older version: