Skip to main content

Versioning & deprecation

The API is versioned in the path (/api/v1/…). Within a version, changes are additive: existing fields and shapes never change meaning, so you can integrate against v1 and rely on it.

What's safe to depend on​

  • The response envelope (success / data / error / meta).
  • Error codes (the strings in Errors) — stable; messages are not.
  • Documented request and response fields. New optional fields may appear over time, so ignore unknown fields rather than rejecting them.

Deprecation signals​

When an endpoint is being retired, you get HTTP signals before it goes away:

  • Deprecation: true — the endpoint is deprecated.
  • Sunset: <http-date> — the date after which it may stop working.

Watch for these headers in your integration's logs, and migrate before the sunset date. Breaking changes ship under a new version path, never silently within v1.

Keeping up​

The API Reference on this site is generated from the platform's OpenAPI spec, making it the source of truth for current shapes. Material changes are communicated to integrated publishers ahead of time.