Versioning
The CAIL Health API is versioned by a path prefix. The current version is v1, and every endpoint path in this reference begins with /v1.
A version is a stable contract. While v1 is current, your integration can rely on its endpoints, request shapes, and response shapes continuing to behave as documented.
Compatible changes
The following changes can be made within v1 without a new version, because an existing client keeps working:
- Adding a new endpoint.
- Adding a new optional request parameter or field.
- Adding a new field to a response.
- Adding a new value to an open-ended list.
Write clients defensively so these changes do not break them: ignore response fields you do not use, and do not assume a fixed set of values where the API may add more.
Breaking changes
Changes that could break an existing client, such as removing or renaming a field, changing a field’s type, or changing an endpoint’s behavior in an incompatible way, are not made within a version. They would be introduced under a new path prefix, leaving /v1 in place.
Deprecation
There is no scheduled deprecation of v1. If a future version is introduced and a deprecation timeline for v1 is set, it will be published on this page.