Versioning
The API version is in the path: /v1. Version 1 is stable.
- Non-breaking changes ship in v1 at any time: new endpoints, new optional parameters, new fields in responses, new event types and new error codes. Write clients that ignore fields they don’t know.
- Breaking changes ship only in a new version (v2). When v2 arrives, v1 keeps working for at least 18 months.
- Deprecated behaviour is announced with
DeprecationandSunsetresponse headers before it goes away.
The current contract is always the OpenAPI spec.
Questions about the API? Contact support, and include the request_id from any error.