Errors

The API uses conventional HTTP response codes to indicate the failure of a request. Codes in the 4xx range indicate a request failed (i.e. a required parameter was omitted). Codes in the 5xx range indicate a system error.

The API returns an error object with each unsuccessful request.

Response

// error object
{
  "error": {
    "url": "/v1/auth/login",
    "request_method": "post",
    "type": "user",
    "code": 400,
    "message": "Required values are missing.",
    "fields": {
      "username": "This value is required."
      "password": "This value is required."
    },
    "dev_message": "Unknown resource."
  }
}

Error types

You can also evaluate the error by checking the error.type. All errors are categorized by one of the following types.

Error codes