Versioning - Synap API (Beta)

The Synap API is internally referred to as the V3 API. Prior versions of our API are not publicly accessible.

This API version is designed to evolve without breaking changes for the foreseeable future. We do not use minor versions for changes; instead, all updates will be additive. This means new endpoints or fields may be introduced, but existing functionality will remain intact. No breaking changes will be introduced under the /v3 namespace unless they are necessary for critical security patches.

In the future, a new major version might be required to further enhance our API's capabilities or improve the developer experience. If that time comes, we will release a new version under the /v4 namespace. We will provide a detailed migration guide and a sunset period to help your organisation transition smoothly. Although we cannot commit to specific timelines for a new major release or the duration of support for a deprecated version, we will engage with all organisations using the API to determine a reasonable transition period, which will likely not be shorter than six months.

While we strive to avoid breaking changes, we recommend that you only rely on the API endpoints and data necessary for your use-case. The more you depend on specific response structures, the more tightly coupled your integration becomes with the API. For instance, if you only need the status code from a response, consider ignoring the body content to minimize potential migration effort in the future.

We do not frequently publish API changes at this time, but this may change based on interest and feedback from our developer community.