Skip to main content
Every Oviond API response — success or failure — uses the same JSON envelope, so your client can parse one shape everywhere. All fields are snake_case.

​
Success envelope

List endpoints add pagination fields to meta. See Pagination, filtering & sorting.

​
Error envelope

Every error returns this shape with the matching HTTP status — including 401 and 403. There are no plain-text error bodies.

​
Validation errors

400 and 422 responses add a details object with per-field messages, so you can surface exactly which field failed:

​
Status codes

A 404 is also returned when a resource exists but belongs to a different account — Oviond never reveals whether an ID exists outside your tenant.

​
Request IDs

Every response includes an X-Request-Id header, and every error repeats it as meta.request_id. If you send your own X-Request-Id, Oviond preserves it so you can correlate requests across your systems and ours.
When something looks wrong, capture the request_id and include it when you contact support — it lets us find the exact request in our logs.