/ General
Errors
HTTP Status Codes
The API uses standard HTTP status codes to indicate the success or failure of a request. Codes in the 2xx range indicate success; codes in the 4xx range indicate a client error; codes in the 5xx range indicate a server-side problem.
| Status | Name | Description |
|---|---|---|
200 | OK | Request succeeded. |
400 | Bad Request | Missing or invalid parameters, or missing version prefix. |
401 | Unauthorized | Missing or invalid API key. |
404 | Not Found | Unknown endpoint, or no data found for the given parameters. |
405 | Method Not Allowed | Only GET requests are supported. |
500 | Internal Server Error | Something went wrong on our end (rare). |
Error Response Format
All error responses return the relevant HTTP status code along with a JSON body with a single error field containing a human-readable description of what went wrong. For example, a request missing a version prefix will return the following:
HTTP/2 400
{
"error": "API version required. Use /vN/ prefix, e.g. /v1/candidates"
}