Getting started
API Versioning
Learn how to version your APIs to manage changes and maintain backward compatibility.
When breaking changes are made to the API, a new version is released. For all API updates, view the changelog on each API. API versioning is only provided via the uri path.
Backwards-compatible changes
We consider the following changes to be backwards-compatible:
- Adding new API resources.
- Adding new optional request parameters to existing API methods.
- Adding new properties to existing API responses.
- Changing the order of properties in existing API responses.
- Changing the length or format of object IDs, error messages, and other human-readable strings.
Deprecation
Deprecated api endpoints will be removed nearby one year after the new api version was published. This will be documented in the IntegrationHub.