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.
StatusCodeMeaning
401invalid_api_keyThe X-Api-Key header is missing, malformed, revoked or unknown.
403missing_permissionThe key does not have the permission the call needs.
404not_foundThe path does not exist.
404job_not_foundThe job does not exist, or it is not published.
404candidate_not_foundThe candidate does not exist.
404application_not_foundThe application does not exist.
404list_not_foundThe list does not exist.
404sequence_not_foundThe sequence does not exist.
400missing_required_fieldA required field is missing. The param says which one.
400invalid_fieldA field is not valid. The param says which one.
409already_appliedThe candidate already applied to this job.
409invalid_transitionThe change is not allowed in the current state of the job or the application.
409sender_not_availableThe job owner is not available to send the rejection email.
429rate_limitedToo many requests. Wait for Retry-After seconds.
500internal_errorSomething failed on our side. Quote the requestId when you contact us.