Skip to content

API versions and changes

How the DICE API changes, and what stays stable within a version.

The version is in the path

The current version is v1 (/api/v1/…). GET /api/v1/me returns api_version.

What can change within v1

  • New endpoints, new optional request fields, new response fields and new event types.
  • New values in fields documented as open lists (for example lead sources).

Build receivers that ignore fields they do not know.

What needs a new version

Removing or renaming a field, changing a type, making an optional field required, or changing what an endpoint does. A new version runs next to the old one for at least 12 months, and every account with an active key hears about it by email before the old version is retired.

Changes are listed in the changelog.