Field-level delta between two schema versions
GET/api/v1/categories/:code/diff
Required scope: schema:read. Returns the added / removed / changed
fields between two FormTemplate versions of an in-scope category, so an
integrator can see exactly what a regulatory schema update changed before
re-mapping. Unknown category code or unknown version → 404 (no oracle).
Request
Responses
- 200
- 400
- 403
- 404
- 429
- 503
Schema diff
Missing from/to query parameter.
403 — missing scope (FORBIDDEN_SCOPE) or module (FORBIDDEN_MODULE).
404 — not found OR owned by another tenant (NOT_FOUND; IDOR-safe).
429 — RATE_LIMITED (per-key limit, reads and writes alike; fails closed,
so a limiter outage also returns 429). A limiter-down 429 is deliberately
indistinguishable from a quota 429. Carries Retry-After (seconds).
Response Headers
Seconds to wait before retrying (429 only).
Per-minute request ceiling for this key's tier.
Requests left in the current window (floored at 0).
Seconds until the window resets.
503 — the API is not enabled on this environment (FEATURE_DISABLED).