Versioning and changelog
/v1 stays compatible — what counts as a breaking change, how we announce it, and every change to the API.
The version is in the path: /api/v1. Within /v1 the API only grows; nothing you
rely on is taken away or changes meaning.
What may change within v1
New endpoints, new optional request fields, new fields in an answer or a webhook payload, new problem codes, new event types and new enum values in an answer. None of these is a breaking change, so:
- ignore fields you do not know;
- ignore event types you did not subscribe to or do not know;
- code defensively against an enum value you do not recognise — there is no promise either way.
The names version, changedBy and previous are reserved in every read shape.
What is a breaking change
Removing or renaming anything, making a field required, narrowing a type, or changing
what something means. A breaking change comes as /v2. /v1 keeps working for at least
six months after that, the change is announced on this page, and the old version's
answers carry Deprecation and Sunset headers in the meantime.
Changelog
Every change to the contract, newest first. The first entry appears on the day the API is released.