Skip to main content

​
URL path versioning

Every stable endpoint is prefixed with /v1/. A breaking change ships under a new prefix (/v2/) rather than changing /v1/ in place, so an integration pinned to /v1/ keeps working indefinitely.

​
What counts as non-breaking

These can land in the current version without a prefix bump:
  • New optional request fields
  • New response fields
  • New endpoints
  • New error code values

​
What counts as breaking

These always ship under a new path prefix:
  • Removing or renaming a field
  • Changing a field’s type or semantics
  • Removing an endpoint or a scope

​
Deprecation

A deprecated endpoint or field is announced here, in the developer docs, before removal — not silently dropped. Check this page (or the OpenAPI spec’s info.description) for the current status of anything you depend on.