Circle APIs: Common Error Responses

General error format

Whenever an API request results in an error, the response will contain both a high-level error class specified by the status code and a human-readable within the body.

HTTP/1.1 400 Bad Request
Content-Type: application/json

{
 "code": 2,
 "message": "Invalid entity.\n[<error-message1>...\n<error-messageN>]"
}

Extended error format

In some cases there is extended information available for clients about why a request has failed. For example, failing to supply a value for a required field1 will result in the following error:

HTTP/1.1 400 Bad Request
Content-Type: application/json

{
 "code": 2,
 "message": "Invalid entity.\nfield1 may not be null (was null)",
 "errors": [
   {
     "error": "required",
     "message": "field1 may not be null (was null)",
     "location": "field1",
     "invalidValue": "null",
     "constraints": {} # see below for details
   }
 ]
}

Extended error response contains a list of one or multiple error descriptions associated with it. Error description attributes should be read as follow:

Error types

There is a set of existing errors which can be handled by clients in an automatic way. Here is the list of error names with example messages and constraints, if applicable: