- Version prefix: all endpoints are served under a major-version URL prefix, currently
/v1(https://api.fuelboss.net/v1/...). A major version covers the entire API: every endpoint is available under the current version prefix. - Non-breaking changes — new endpoints, new optional fields, new enum values, new webhook event types — are added to the current version and listed in the changelog when released.
- Changes to existing behaviour in the current version that may require your attention — for example a field becoming nullable — are listed under Upcoming changes in the changelog at least 4 weeks before they take effect.
- Breaking changes result in a new major version (
/v2,/v3, etc.). A migration guide is provided with every new major version. - Deprecation: when a new major version is released, the previous version is marked deprecated. Deprecated versions remain fully supported for 6 months from the deprecation date, after which they are removed.
Reference
Versioning
How the FuelBoss API is versioned, how changes are announced, and how long deprecated versions are supported.