Indeed · Schema

ApiError

An error returned by the Indeed API.

CareersEmploymentHiringJob SearchJobsRecruiting

Properties

Name Type Description
code string A machine-readable error code.
message string A human-readable description of the error.
field string The field that caused the error, if applicable.
View JSON Schema on GitHub

JSON Schema

indeed-apierror-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ApiError",
  "title": "ApiError",
  "type": "object",
  "description": "An error returned by the Indeed API.",
  "properties": {
    "code": {
      "type": "string",
      "description": "A machine-readable error code.",
      "example": "INVALID_INPUT"
    },
    "message": {
      "type": "string",
      "description": "A human-readable description of the error.",
      "example": "The employer name field is required."
    },
    "field": {
      "type": "string",
      "description": "The field that caused the error, if applicable.",
      "example": "employerName"
    }
  }
}