REST Countries · Schema

ErrorResponse

Error response returned by the REST Countries API when a request fails

CountriesGeographyWorld DataFlagsCurrenciesLanguagesPopulation

Properties

Name Type Description
errors array Array of error objects describing what went wrong
View JSON Schema on GitHub

JSON Schema

error-response.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api.restcountries.com/schemas/error-response.json",
  "title": "ErrorResponse",
  "description": "Error response returned by the REST Countries API when a request fails",
  "type": "object",
  "required": ["errors"],
  "properties": {
    "errors": {
      "type": "array",
      "description": "Array of error objects describing what went wrong",
      "minItems": 1,
      "items": {
        "type": "object",
        "required": ["message"],
        "properties": {
          "message": {
            "type": "string",
            "description": "Human-readable description of the error",
            "examples": [
              "Authorization key required.",
              "q parameter is required and cannot be empty",
              "Access to premium fields requires a paid plan.",
              "Unknown property or aggregate."
            ]
          }
        }
      }
    }
  }
}