Errors
Every error has the HTTP status of the table below and the same JSON body. Branch on error.code, not on the message, which can change.
{
"error": {
"code": "missing_required_field",
"message": "A required field is missing",
"param": "email",
"requestId": "b6f2c9d0-0f4e-4d0b-9a3e-2f6a1c7d8e90"
}
}code: a stable identifier.message: a description for people.param: the field the error is about, or null.requestId: quote it when you contact us about a request.
| Status | Code | Meaning |
|---|---|---|
| 401 | invalid_api_key | The X-Api-Key header is missing, malformed, revoked or unknown. |
| 403 | missing_permission | The key does not have the permission the call needs. |
| 404 | not_found | The path does not exist. |
| 404 | job_not_found | The job does not exist, or it is not published. |
| 404 | candidate_not_found | The candidate does not exist. |
| 404 | application_not_found | The application does not exist. |
| 404 | list_not_found | The list does not exist. |
| 404 | sequence_not_found | The sequence does not exist. |
| 400 | missing_required_field | A required field is missing. The param says which one. |
| 400 | invalid_field | A field is not valid. The param says which one. |
| 409 | already_applied | The candidate already applied to this job. |
| 409 | invalid_transition | The change is not allowed in the current state of the job or the application. |
| 409 | sender_not_available | The job owner is not available to send the rejection email. |
| 429 | rate_limited | Too many requests. Wait for Retry-After seconds. |
| 500 | internal_error | Something failed on our side. Quote the requestId when you contact us. |