API Versioning Support for Public Documentation

/in

Building Stable Integrations

Creating stable, future-proof integrations has become simpler. We’ve launched API Versioning for our public documentation, allowing developers to reliably access and work with specific API versions without the concern of unexpected breaking changes.

Features of API Versioning:

  • 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.

Benefits of API Versioning:

  • Enables predictable and stable integrations without breaking changes.
  • Provides smoother upgrade paths to newer API versions.
  • Improves developer experience with clear, version-specific references.
  • Builds confidence for teams managing long-term production systems.

Additional Advantages:

  • No impact on existing integrations.
  • Simplifies API adoption and version migration.
  • Lays the groundwork for structured API evolution and deprecation.
  • Enhances transparency through version-level visibility.

Improved Reliability:

  • 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.

To get started, open the API documentation → select the desired version from the version switcher → reference endpoints and schemas for that version → build with confidence.

We are currently working on our next milestone — v3 of our APIs, which will introduce enhanced capabilities, improved performance, and new endpoints for advanced use cases.

Version Selection:

Select the version by toggling at the top of the API documentation:

Group 2133 (1)

Update Notification:

Nudge highlighting that the user is in an older version:

Group 2134