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
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
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:
/unstableis a version root like/v1, and serves everything in/v1too, 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
/v1with the same URIs, so you only change your base URL. - A resource in
/v1never links to an unstable one.