Skip to main content
Fordje Connect uses URL-based versioning to ensure stability for your integrations. This page describes the versioning scheme, what counts as a breaking change, and how deprecations are communicated.

​
Current version

The API is currently at v1. All endpoints are prefixed with /v1/:

​
Versioning policy

  • Major versions are indicated by the URL prefix (/v1/, /v2/, etc.). A new major version is introduced only when breaking changes are necessary.
  • Non-breaking changes (new endpoints, new optional fields in responses, new optional query parameters) are added to the current version without a version bump.
  • Breaking changes (removing a field, renaming a field, changing a field’s type, removing an endpoint, changing required parameters) trigger a new major version.

​
What counts as a breaking change

​
Deprecation process

When a new major version is introduced, the previous version follows this deprecation timeline:
  1. Announcement — The upcoming deprecation is announced in the changelog and via email to all organizations with active API keys. The announcement includes the timeline and migration guide.
  2. Overlap period — Both the old and new versions run simultaneously for a minimum of 6 months. During this period, both versions are fully supported.
  3. Sunset headers — Once a deprecation date is set, responses from the deprecated version include a Sunset header indicating when the version will be retired:
  4. Retirement — After the overlap period ends, the deprecated version returns 410 Gone for all requests. Integrations must migrate to the new version before this date.

​
Staying informed

  • Check the changelog regularly for updates
  • Monitor the Sunset response header in your integration
  • Contact [email protected] if you need assistance with a migration