API Change Policy

Changes to the API which are considered backward compatible can be deployed at any time and without prior notice. Breaking changes in the API will be announced in advance and in certain cases, the API will be versioned to allow consuming both old and new versions at the same time.

Breaking Changes

The following types of changes are considered breaking changes and will be announced in advance:

  • Addition of a required request parameter without specifying a default value
  • Change of data type in request parameter or response field
  • Removal of a field from a response
  • Removal of an endpoint

Important

Breaking changes will be communicated to API users before deployment. In cases where immediate changes are not possible, API versioning will be implemented to allow a transition period.

Non-Breaking Changes

The following types of changes are considered backward-compatible and may be deployed at any time without prior notice:

  • Addition of an optional request parameter or a required request parameter with a default value
  • Addition of new fields in responses
  • Addition of new endpoints
  • Changes to HTTP response/error messages

Best Practice

To ensure your integration remains stable, we recommend implementing your API client to gracefully handle unknown fields in responses. This will prevent issues when new fields are added to the API.

Communication

Changes to the API will be communicated through:

Questions?

If you have questions about API changes or need assistance with your integration, please contact our support team at support@hithorizons.com.