[Go to site: main page, start]

Status Codes and Errors

When interacting with Apollo API endpoints, it helps to understand the status codes that might be returned.

To find a status code for an endpoint:

  1. Go to the reference documentation for an endpoint such as People API Search.
  2. By default, the Response section of the reference docs shows an example response with a 200 status. To view other status codes, click the EXAMPLE drop-down, then select a status code.
  3. The status you select appears in the response section.

You don't need to supply an API key to review the Apollo-generated example response or other status codes. Check out How to Test API Endpoints to perform your own testing and generate unique responses.

Find API status codes in Apollo documentation.

Common status codes

Most Apollo API endpoints share the following status codes. Some endpoints return additional, endpoint-specific codes and error messages — always check the Response examples on that endpoint's reference page for exact details.

Status codeMeaningCommon causeerror_code
401UnauthorizedYour API key or access token is missing or invalid, or your account is no longer active. See Authentication.INVALID_ACCESS_TOKEN (OAuth access tokens)
403ForbiddenYour plan doesn't include API access, or the endpoint isn't available through the public API for your credentials. Contact Apollo if you believe this is an error.API_INACCESSIBLE
404Not foundThe requested record doesn't exist or isn't accessible with your credentials. Double-check the ID in your request.
422Unprocessable entityYour request was received but couldn't be processed — usually a validation error or an invalid or missing parameter. The response body describes the specific issue; the exact shape varies by endpoint.varies by endpoint
429Too many requestsYou've exceeded your rate limit. Rate-limit details are returned in the response headers. See Rate Limits.
500Internal server errorAn unexpected error occurred on Apollo's side. Retry the request; if it persists, contact Apollo.
📘

Status Report

Not all API status codes are currently documented by Apollo. This documentation contains the most common codes.