Versioning

To ensure your integration stays consistent over time, you can pin it to a specific API version using the Circa-Version header.

Circa-Version: 2026-05-11.arrakis

If you omit the header, your request will use the latest supported versionat the time it's processed.

Why pin a version?

Pinning protects you from breaking changes. Once a version is released, its behavior is locked. New fields and behaviors land in a new dated version, never an existing one.

Current versions

Version	Codename	Released	Status
`2026-05-11.arrakis`	Arrakis	May 11, 2026	Latest

Pin a default to a key

In the Developer portal, you can pin a default version per API key.

Any requests made with that key that doesn't include a Circa-Versionheader will use the pinned version instead of the global latest — useful for legacy integrations that you don't want to upgrade in lockstep with new keys.

Errors

A 400 Bad Request is returned if Circa-Version is set to an unknown value.

400Bad Request

{
  "statusCode": 400,
  "message": "Unknown circa-version '1999-01-01'. Supported: 2026-05-11.arrakis."
}