Developers / Versioning

Versioning

v1 only gains things. A breaking change would come as /api/v2, alongside v1, with v1's retirement date announced.

Updated 4 November 2026API v1.0.1

What v1 promises#

Within v1, nothing you use is taken away or renamed: operations, fields, event names and error codes stay as they are. What can be added:

  • New operations.
  • New optional fields in requests.
  • New fields in answers and event payloads.
  • New error codes, and new webhook events you can choose to subscribe to.

Build your client to ignore fields it doesn't know, and to cope with a value it doesn't recognise. Treat an unknown error code by its HTTP status.

Version numbers#

The URL stays /api/v1. The spec's info.version (now 1.0.1) goes up on every change: the last number for fixes, the middle one for additions.

Check the current version (no key needed)
curl -s https://coresyncapi.avitechcloud.com/api/v1/openapi.json | jq -r .info.version

Breaking changes#

If something ever has to change in a way that would break you, it will be published as /api/v2. v1 keeps running beside it, and the date v1 retires is announced on the changelog well before it happens.

Stay informed#

Every change is on the changelog. Questions about a change? Write to hello@coresyncisp.com.

NextChangelog →

Stuck, or missing something? Tell us what you're building.

hello@coresyncisp.com