Versioning

The Omnia API uses calendar versioning (YYYY-MM-DD format) to provide clear version identification and predictable release cycles. This approach ensures transparency in API evolution and helps you plan integration updates effectively.

Specify your desired API version using the Version request header. Response headers include both the Version used to process your request and the Latest-Version available, helping you stay informed about API updates.

We introduce new versions only for backward-breaking changes, ensuring existing integrations remain stable. Breaking changes include endpoint removal, attribute removal, field type modifications, new required parameters, and authentication changes. Non-breaking additions like new endpoints, optional parameters, and additional response fields are added to existing versions. All deprecated versions receive 180 days of continued support, providing adequate time for migration planning and implementation.