Skip to main content

Versioning

The API is versioned by namespace:

  • Current: /api/v1/public

Breaking changes should ship in a new major API namespace without changing v1 contracts.

Compatibility​

Within v1, clients should expect additive, backwards-compatible changes such as:

  • New optional response fields
  • New optional request fields
  • New endpoints
  • New enum values where the API domain expands

Clients should ignore unknown response fields.

Breaking Changes​

Breaking changes include:

  • Removing or renaming fields
  • Changing field types
  • Changing authentication requirements
  • Removing enum values
  • Changing endpoint paths or required permissions

Breaking changes should be introduced under a new major namespace, such as /api/v2/public.

OpenAPI Spec​

The OpenAPI JSON is published with the docs site and is the source of truth for endpoint shapes, request fields, response fields, and examples.