Examples for every endpoint
2026-11-17 · Not breaking · Upcoming: not yet in production
Every operation of the reference now shows an example with invented data: of its request body, of
each response with a body and, for each error status it documents, of the most likely problem with
that status, with the fields the API actually sends, correlationId and traceId included.
What changed
- The other problems an operation can answer with are named in its description.
- Every operation that needs an API key or a token documents its 401,
https://tools.ietf.org/html/rfc9110#section-15.5.2withtitle,statusandtraceId, as doPOST /api/v1/auth/loginandPOST /api/v1/auth/refreshfor credentials they reject. - The reference now also names the problem types
node-name-taken,node-not-found,order-line-not-found,order-not-modifiable,status-flow-not-found,user-not-foundandwebhook-not-found, which the API already sent. - No route, request, response or status changes.
Affected operations
- Every operation of the tenant API v1, in the reference only.
What you do
- Nothing. Use the examples when you build or test a call.