Version Migration

Affinity API v2 uses date-based versioning: breaking changes are introduced only in new versions, so your existing integrations remain stable on the version they were created against. Beta endpoints are an exception — see Beta Endpoints, where breaking changes may occur without notice or versioning. For how an app’s default version is set and overridden per request, see Versioning. This page lists the migration steps, if any, required to adopt each version. For additive, non-breaking changes (new endpoints, new response properties, and other improvements within a version), see Previous Changes.

​

2024-01-01

2024-01-01 is the initial stable release of Affinity API v2. No migration steps are required to adopt this version.

​

2026-07-15

​

Restricted opportunity field access in list-entry fields

If your integration reads list-entry fields via any of the endpoints below, field values for opportunities that your app does not have permission to manage will now be returned with type: "hidden" and value.data: null instead of the real value. Action required:

• Update your code to handle type: "hidden" responses gracefully. Do not assume all field values in a list-entry response will have a known type and non-null data.
• If your integration writes to list-entry fields (PATCH/POST), calls targeting a field on a restricted opportunity will now return 403 Forbidden. Check the response status and handle accordingly.

Affected endpoints:

​

quarter added to relative date unit enum

The unit property in relative date filter requests now accepts quarter as a valid value, and relativeDateUnits in filterability responses now includes quarter. Action required:

• If your integration validates or switches on the relativeDateUnits values returned by filterability endpoints, add quarter as a handled case.
• No action is required if you only use relative date filters with existing unit values.

---