Responses & errors
The data success envelope, the standard error shape, and what each HTTP status means.
Every response uses the same envelope — success wraps the payload in data, and errors always share one shape.
{ "data": { "...": "..." } }{
"status": "error",
"message": "Human-readable explanation",
"errors": { "field": ["what went wrong"] }
}Status codes
| Status | Meaning |
|---|---|
200 / 201 / 202 | Success (202 = async job queued) |
400 | Bad request / business-rule rejection |
401 | Missing or invalid token |
403 | Authenticated, but out of scope or feature disabled |
422 | Validation failed — errors lists each field |
429 | Rate limit exceeded — retry after the Retry-After header |
Updated 15 days ago
Did this page help you?