This document describes how API versioning appears in the documentation and URLs, and how deprecation is communicated.

Release

A release is a deployment of changes to the Give Interactive application. The REST API is deployed with the release, which may or may not include REST API changes. A release may include new endpoints or new versions of existing endpoints.

Documentation versions

The REST API documentation is versioned by the release. For example, the fifth release in 2026 would have a documentation version of 26.05.00. When a hot-fix is deployed, the patch number is incremented, for example 26.05.01.

API versions (/api/v1)

Each endpoint has its own version, starting with v1, included in the endpoint's path. It is acceptable to use endpoints with different versions in the same integration.

Endpoint versions are independent of the documentation version and of the release.

Major changes

Changes that break the interface — such as adding a required field or changing a response shape — are major changes. A new endpoint version is added, and the old version may be deprecated.

Minor changes

Adding optional parameters or fields, or adding more information to a response, are minor changes and do not prompt a version change.

Deprecation policy

• Deprecated operations or fields are documented in the API documentation and in the Changelog.

• When an API or behavior has a fixed end date, that date is posted alongside the deprecation notice so integrators can plan migrations.

• New development must not use deprecated APIs — use the documented replacement when one exists.

For the current list of deprecations and any removal dates, see the Changelog and your Give Interactive communication channels.

Exceptions

The token operation is documented with separate server entries pointing at an /oauth host (for example https://api-sandbox.giveinteractive.com/oauth). Token issuance is not under the /api/v1is a minor change and does base. See Authentication.