Skip to main content
The API is versioned in the path: /v1.

​
Additive within a version

Inside v1, changes are additive. New endpoints and new response fields may appear at any time; an existing field is never removed, renamed, or changed in meaning. Write clients that ignore unknown fields: a new one is not a breaking change and will arrive without notice. A change that would break an existing integration, such as removing a field, changing a type, or changing a default, ships as a new major version (/v2), never inside v1.

​
Deprecation

Anything on the way out is marked deprecated in these reference pages and in the OpenAPI document before it is removed. A deprecated endpoint keeps working through its notice period. When a response header carries deprecation information it follows the IETF conventions (Deprecation and Sunset).

​
The contract

These pages are generated from wondeya’s OpenAPI document, the same contract the server serves. It is the source of truth for what a route accepts and returns; when it and prose disagree, the OpenAPI document is right.