Versioning & compatibility

/v1 is the supported current major version of the Partner API, used by every API integration — internal system or external partner.

• New optional response fields and new optional request fields.
• New endpoints and new event types or enum values, where clients that ignore unknown values remain safe.

Build clients to ignore unknown fields and unknown event types.

• Removing or renaming a field, endpoint or event.
• Changing a field's type or meaning.
• Adding a new required request field.
• Weakening authentication, scope or idempotency guarantees.

Breaking changes require a future major version. Existing field semantics in v1 are not silently changed.

Deprecated behavior is explicitly marked in the reference and the changelog, with the replacement documented. No contractual deprecation window is currently published.

Where a collection is cursor-paged, the response includes next_cursor; pass it as cursor on the next request with an optional limit. The event stream is cursor-paged. Other responses are bounded as stated on their reference page.

• Sandbox and Production use separate API keys with distinct prefixes and separate Program access.
• Sandbox is synthetic only — never send real patient data. A Sandbox key cannot access Production.
• Production access is activated separately; Sandbox success does not activate Production, and Production key issuance keeps its existing multi-factor checks.