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. When you see these headers, you have 30 days to migrate before the version is retired. The Dealroom API is in Early Access and under active development. A pinned version is supported for 30 days past the date it is superseded; after that it returns 400. (This window widens to 90 days at general availability.)

​
Current versions

See the Changelog tab for the full list of API versions, their status (current, deprecated, sunset), and migration notes for each release.

​
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.
You have 30 days from when Deprecation and Sunset headers first appear to complete your migration.

​
Changelog

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