Response codes

The following response codes can be expected from the API and should be handled by consumers.

• 200 OK - A successful call. Will be returned for both GET, POST, PUT and DELETE
• 401 Unauthorized - Missing Bearer header or failed authentication
• 404 Not Found - The endpoint does not exist.
• 422 Unprocessable Entity - Missing required data or malformed data in the input. For example wrong format for filter_str.
• 429 Too Many Requests - Request rate limit hit.
• 500 Internal Error - Something went wrong on our end. Please contact Next support if this happens.

In the case of the response code, HTTP 422 Unprocessable Entity the body of the response will contain a structured error object in JSON format as in the examples below.

Example 1 - filter string is not valid JSON

{
  "detail": {
    "loc": [
      "filter_str"
    ],
    "msg": "Failed to decode json",
    "type": "format"
  }
}

Example 2 - field name in the filter is not valid. Please consult the schema for ProjectGet to see what fields are available.

{
  "detail": {
    "loc": [
      "filter_str"
    ],
    "msg": "Invalid filter fields for ProjectGET: {'non existing field'}",
    "type": "format"
  }
}