Skip to main content
The Dealroom API uses date-based versioning (Stripe-style). Every breaking change is assigned a calendar date. Clients pin a version; the API downgrades responses and upgrades requests automatically so your integration keeps working without immediate code changes.

​
Specifying a version

Send the API-Version header with a YYYY-MM-DD date:
If omitted, the latest version is used automatically.

​
Response headers

Every response includes version metadata: Deprecation and Sunset only appear when you’re on an older version than the latest. Sunset is a fixed calendar date — 30 days after the version that superseded yours — not a countdown that starts when you first see the header. Read the date off the header rather than assuming 30 days remain: if your integration has been quiet, some of the window is already spent. A version is dated when its first change was made, which can be before it reaches production, so the window can start before the superseding version is available to you. The Dealroom API is in open beta and under active development. A pinned version is supported for 30 days past the date it is superseded. This 30-day window holds for the whole beta. We intend to widen it to 90 days at general availability — until then, 30 days is the window.

​
How a breaking change reaches you

Every breaking change is recorded on the Changelog tab, published with the release that ships it. You don’t have to watch that page: as soon as a newer version supersedes the one you have pinned, every response carries Deprecation and Sunset headers, and your pinned version keeps working until the Sunset date those headers carry — 30 days after the supersession, not 30 days after you noticed.

​
Current versions

See the Changelog tab for the full list of API versions, their status (current or deprecated), and migration notes for each release. There is no third status for a retired version. A version is retired on its Sunset date: from that date, requests pinned to it return 400. Migrate before then.

​
Pinning a version

Pin a version by sending the API-Version header on each request (see Specifying a version above). Omit it to use the latest version.

​
Error responses

​
Invalid format

​
Version no longer supported

​
Migration guide

When a new version is released:
  1. Check the changelog (below) to understand what changed.
  2. Update your integration to use the new field names, params, or error handling.
  3. Test against the new version by sending API-Version: <new-date> in requests.
  4. Update your pinned version once you’re confident the migration is complete.
Migrate by the Sunset date on your responses. That date is 30 days after your version was superseded — not 30 days from when you first noticed the headers.

​
Changelog

See the full Changelog tab for all version changes, migration guides, and affected endpoints.