Versions
Each major version has its own base path. The version you call doesn’t change until you change the path.Breaking changes
A change is breaking if it can make a working integration fail or behave differently. Supported versions never get these changes, apart from the exceptions:- Removing or renaming an endpoint, field, parameter, or enum value
- Changing a field’s type or format
- Adding a required request field, or making an optional one required
- Rejecting a request that’s accepted today
- Changing a write’s side effects, such as a delete becoming an archive
- Changing a list endpoint’s defaults: filters, sort order, or page size
- Changing authentication or authorization requirements
- New endpoints, resources, and response headers
- New optional request fields and parameters
- New response fields and enum values
- Changes to the order of response fields, or to the length or format of IDs
Exceptions
A supported version can get a breaking change only to fix one of the issues below. The fix ships to every supported version that serves the endpoint.
Security fixes can ship without advance notice. DualEntry announces them on this documentation site.