Error Response Structure
All API errors return a JSON response with the following structure:Error Response Structure
Response Fields
Standard HTTP response codes are always returned in addition to the error body.A URI that uniquely identifies the error type. Always use this field to identify and
handle specific errors programmatically.
The HTTP status code of the response (e.g., 400, 404, 500). This is always set in the
actual HTTP response also.
A short, human-readable summary of the problem type.
A human-readable explanation specific to this occurrence of the problem.
Additional fields (extensions) may be present depending on the specific error type.
See the response documentation for specific endpoints for details on any extensions.
Error Identification
Always use thetype field to identify errors programmatically. The type contains the full URL path to the specific error documentation:
Error Identification Example