Developer Documentation

API Versioning

Learn about the FundraiserMax API versioning strategy, backward compatibility, and migration between API versions.

Versioning

The FundraiserMax API is versioned via the URL path. The current version is v1, accessed at /api/v1/.

Stability Guarantees

Within a major version (e.g., v1), we guarantee the following:

  • Existing endpoint paths will not change.
  • Existing response fields will not be removed or have their types changed.
  • New optional fields may be added to response objects.
  • New optional query parameters may be added to existing endpoints.
  • New endpoints may be added.

Breaking Changes

Breaking changes (removing fields, changing types, altering behavior) will only occur in a new major version (e.g., v2). We will provide at least 6 months of deprecation notice and run both versions in parallel during the transition period.

Note: Subscribe to the API Changelog for notifications about new features, deprecations, and version changes.