All requests to the API must provide an Accept header containing the version your application expects to handle the request.
Be sure to provide the version of the API on every request – the examples in these docs contains a version header for you.
The current version is v2.
Absolutely. In fact, we use the API within the application.
Any breaking changes introduced to the interface will require a version bump in order to be adopted. We will do our best to never introduce breaking changes to any supported version of the API. We do not consider the following to be breaking changes:
- 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.
- Adding new event types - your webhook listener should handle unknown webhook events gracefully.
( * this will be eventually deprecated but most endpoints still work. You are encouraged to use the latest version for the action you want to run.)
Some features on old API versions are no longer available, these are documented where this is the case. We have no plans to drop support for current versions of our API in the near future, however when we do – we will communicate a timeframe with all our customers still making requests with the version being dropped. We care deeply about our customers and will never intentionally cause any integrations to break.