Versioning

How the API changes, and how we tell you.

The version is in the path: /api/v1.

Within v1 we only make changes that don’t break a correct integration:

• new endpoints;
• new optional request fields;
• new response fields;
• new error codes and new values of status.

Read responses tolerantly: ignore fields you don’t know.

A breaking change gets a new version (/api/v2), announced to API account owners in advance.

The machine-readable description of the API is at /api/v1/openapi.json, for Postman or a client generator.