Skip to content

Error Response Format

Every non-2xx response returns a JSON object with the same two fields.

FieldTypeDescription
messageStringHuman-readable description of what went wrong
nameStringError class name, for branching in client code
{
"message": "Not found",
"name": "ItemNotFoundException"
}
nameStatusMeaning
MissingParamsError422A required parameter is missing
ValidationError422Parameter content failed validation
AuthenticationError401Authentication failed
UnauthorizedError403Access denied
ItemNotFoundException404Resource not found
ItemExistsException409Resource already exists
QuotaExceededError402Plan quota exceeded
ConfigurationError503Service temporarily unavailable

Errors outside this list are returned as 500 with the same body shape.

See Error Code for the status codes themselves.