Errors
A returned error indicates that the request was unsuccessful.
The error will be returned in the top-level error property of the JSON response.
For more information, see HTTP response codes.
Error object
{
"error": {
"status": 404,
"title": "Not Found",
"message": "Not Found",
"link": null,
"code": 0,
"request_id": "bf96dc8507",
"elapsed": "0.017",
"time": "2026-06-27T14:22:11+00:00"
}
}
Fields
- statusrequired readonly integerHTTP status code of the error.
- titlerequired readonly stringShort title of the error describing the HTTP status.
- messagerequired readonly stringDetailed message describing the error.
- linknullable readonly stringOptional link to documentation or additional information about the error.
- codereadonly integerOptional application-specific error code.
- request_idrequired readonly stringUnique request ID.
- elapsedrequired readonly stringTime elapsed (in seconds) to complete the request.
- timerequired readonly stringUTC timestamp in ISO 8601 format when the error was generated.
Was this page helpful?