ErrorResponse

A standard format for error responses that may be returned by the API when various types of errors occur, including authentication (sign-in) failures, authorization (permission) failures, "object not found" (404), internal server errors (500), bad client requests (400) and other types of errors.

error object

A detailed error object that includes a code and message for the error that occurred. This is useful for client applications to display to users or to log for debugging purposes.

codestring

A short code that identifies the type of error that occurred. This helps group related errors into categories for common treatment in the user interface or client program.

Some of the common codes are listed on the Core Concepts#Fixed error codes page.

Example: NotFoundOrNotAuthorized

messagestring

A human-readable message that describes the error that occurred.

Example: You must be signed in to access this resource. If you are making an API call, please check the section of the documentation on authentication.

errorsstring[]

An array of error messages that may be returned by the server. Usually this has the same content as the error object's message field, but this array may contain additional messages or details.

response_codeinteger

The HTTP status code of the response. This is useful for client applications to determine the type of error that occurred.

Example: 401

successboolean

Indicates whether the request was successful (normally false if it's an error response)

Default value: false

tracebackstring

A full traceback of the error that occurred on the server. This is useful for debugging and troubleshooting. Note that the traceback is only available if the server is in development mode.

Example: Traceback (most recent call last): ... (full traceback)

ErrorResponse

{
  "error": {
    "code": "NotFoundOrNotAuthorized",
    "message": "You must be signed in to access this resource. If you are making an API call, please check the section of the documentation on authentication."
  },
  "errors": [
    "You must be signed in to access this resource. If you are making an API call, please check the section of the documentation on authentication."
  ],
  "response_code": 401,
  "success": false,
  "traceback": "Traceback (most recent call last): ... (full traceback)\n"
}