API Versioning and Deprecation Notices

We try to only make backwards compatible changes, but sometimes we have to make a breaking change to iterate on the API.

Backwards Compatible Changes
The following changes are considered backwards compatible:

  • Add properties to JSON objects.
  • Alter the number of items returned in a single listing request.
  • Modify rate limiting thresholds.
  • Change the structure or length of identifiers generated by the API.
  • Update error messages.

Backwards Incompatible Changes
The following changes are considered backwards incompatible:

  • Removal of properties from JSON objects.
  • Changes to an API's URL structure.

If we introduce backward incompatible changes, deprecate an API or an endpoint you are using, we will notify you via email at least 60 days in advance.