Backward compatibility and API updates

While we won’t introduce any breaking changes, we plan on adding new features and new endpoints over time. This is a list of changes we consider to be backwards compatible:

  • Adding new fields or links to the responses
  • Adding new resources or endpoints
  • Adding new (optional) request parameters
  • Changing default page length for paginated resources

Please consider this when programming against the API and try to make sure these non-breaking changes don’t break your code.

If we introduce a breaking change, we will create new endpoints with a new version prefix in the URI.