API Errors

When there is an error with any of the API calls, the response will have a non-200 HTTP status code and a JSON body describing the error. Besides from the common API errors listed, each API call will have its own errors described in their respective sections.

Property	Type	Description
errors	Error[]	see Error resource

Example:

{
  "errors": [
    {
      "error_code": "NOT_AUTHENTICATED",
      "error_message": "please authenticate",
      "more_info": "[http://www.yelp.com/developers/documentation/v2/overview](http://www.yelp.com/developers/documentation/v2/overview)"
    }
  ]
}

Error

Property	Type	Description
object	utf8_string(1..256)	object type, value: `Error`
error_code	utf8_string(1..64)	error code
error_message	utf8_string(1..1024)	error message
more_info	utf8_string(1..1024)	link to Yelp docs for the error message

Common API Errors

Status	error_code	error_message (example)
400	FIELD_REQUIRED	is required
400	VALIDATION_ERROR	is invalid:
401	UNAUTHORIZED	Please authenticate
500	INTERNAL_SERVER_ERROR	Something is wrong with Yelp