Skip to main content
The major version is in the path: https://api.quidkey.com/v1.

Additive Changes

These arrive without notice:
  • new endpoints, and optional request fields
  • new response fields, enum values and error codes
  • new included links, and permissions added to roles
A new value for a status field comes with notice, because integrations often branch on it.

Breaking Changes

These arrive only in a new version:
  • removing or renaming anything
  • changing a type, a unit or a meaning
  • tightening a request, or changing a default
  • changing an endpoint’s permission, or the code an existing failure reports
  • removing a default inclusion
A security or regulatory need can require a faster change, and we’ll say so when it does. When we retire something, we’ll give at least 6 months’ notice, and its responses will carry Deprecation and Sunset headers.

What We Ask of Your Client

  • Ignore fields you don’t recognise, and don’t validate responses strictly against a closed schema.
  • Handle enum values and error codes you haven’t seen.
  • Treat a link with no matching entity as normal.
  • Don’t parse IDs, cursors or URIs.

Unstable Endpoints

https://api.quidkey.com/unstable is reserved for new or experimental endpoints, before they settle. No endpoint is published there. When the first one is, these will hold:
  • /unstable is a version root like /v1, and serves everything in /v1 too, so URIs resolve the same way against either.
  • These standards apply, except the compatibility promises: an unstable endpoint can change or disappear without notice.
  • The reference marks each unstable endpoint.
  • When an endpoint settles, it moves into /v1 with the same URIs, so you only change your base URL.
  • A resource in /v1 never links to an unstable one.