Versioning
How the API is versioned, what counts as a breaking change, and how we tell you.
The current version is v1. It is in the path (/api/v1), and every response carries X-API-Version: v1.
What we may change in v1#
- Add new endpoints, optional request fields, response fields, enum values and webhook events.
- Change the wording of error messages. Branch on status and codes, not on message text.
Build your client to ignore fields it does not know.
What needs a new version#
Removing or renaming a field, changing a type, or making an optional field required. We will announce any such change in the changelog with notice before it applies.