Versioning

What we may change in v1 without notice

• New endpoints.
• New optional query parameters.
• New fields in responses. Your client should ignore fields it does not know.
• New event types. You only receive the ones you subscribe to.
• New values in a list of possible values, such as an opportunity type. Handle unknown values gracefully.
• The wording of error messages.

What counts as breaking

Removing or renaming a field, changing its type or meaning, removing an endpoint, or making an optional parameter required. Breaking changes go into a new version, /v2, and v1 keeps working alongside it for at least six months after we announce the change.

How you will know

Anything scheduled for retirement will carry Deprecation and Sunset response headers stating when it goes, and we will contact every partner whose key has called it. The current version of the specification is always at /api/v1/openapi.json, and responses from the keyed endpoints carry X-API-Version.