Versioning

The API is versioned by date (YYYY-MM-DD). This document describes version 2026-08-27. The version field on GET /v1/status reports the date version the environment is serving.

Compatibility

Additive changes may appear without a version bump:

• New resources and endpoints
• New optional request fields and query parameters
• New enum values (ignore unknown values, or treat them as an unspecified

state)

• New response fields (ignore unknown fields)

Breaking changes ship in a new date version. Examples:

• Removing or renaming a field, path, or enum value
• Changing the type of a field (including encoding money as a float)
• Making a previously optional request field required
• Changing authentication, pagination, idempotency, or error envelope rules

Pinning

Build against the date version in this document. Treat unknown fields as ignorable. When a new date version is published, this page gains a Version history entry listing every breaking change in it. Review that entry and regression-test in sandbox before switching production traffic.

Path prefixes (/v1/...) identify the protocol family. They do not replace the date version.

Version history