Versioning

The Demoboost Public API is versioned via the URL path. The current version is v1.

https://open.demoboost.com/v1/users

What Counts as a Breaking Change

We consider the following to be breaking changes that require a new major version:

• Removing or renaming a field in any response body.
• Changing the type of an existing field (e.g., string → integer).
• Removing an endpoint.
• Changing an HTTP status code for a documented scenario.
• Making a previously optional request field required.
• Changing authentication requirements for an endpoint.

The following are not breaking changes:

• Adding new optional fields to response bodies.
• Adding new endpoints.
• Adding new optional query parameters.
• Fixing bugs that cause incorrect behavior.

Deprecation Policy

When we need to make a breaking change, we will:

1. Announce the change in the changelog.
2. Add a Sunset header to affected responses with the removal date — at least 6 months in the future.
3. Keep the old version alive until the Sunset date.
4. Release the new version under a new path (e.g., /v2/).

Sunset Header

When an endpoint or version is scheduled for removal, its responses will include:

Sunset: Sat, 01 Aug 2026 00:00:00 GMT

Monitor this header in your HTTP client and update your integration before the Sunset date. After that date, requests to the deprecated path will return 410 Gone.

Current Versions