v1

latestOpenAPI 3.1.02026-07-224239180.9 KB

Candidate

Get a candidate

Returns the candidate's identity, contact details, hiring-team assignments, ATS metadata, and anonymization state. For anonymized candidates, PII fields may be redacted; an unknown or out-of-organization ID returns not found.

get/v1/candidates/{candidateId}

Path parameters

candidateIdstring required

a candidate ID. Accepts the canonical prefixed compact UUID, a prefixed dashed UUID, a bare dashed UUID, or a bare compact UUID; input is case-insensitive.

Example:can_a1b2c3d4e5f64789a1b2c3d4e5f64789

Response

Success

idstring required

Canonical candidate ID (can_ followed by 32 lowercase hexadecimal UUID characters).

primary_emailstring email nullable required

additional_emailsstring[] nullable required

Additional candidate email addresses. Null means PII was redacted because the candidate is anonymized; an empty array means no additional email addresses.

phone_numbersstring[] nullable required

Candidate phone numbers. Null means PII was redacted because the candidate is anonymized; an empty array means no phone numbers.

timezonestring nullable required

linkedin_urlstring uri nullable required

preferred_namestring nullable required

anonymizedboolean required

created_atstring date-time required

ISO 8601 timestamp.

updated_atstring date-time required

ISO 8601 timestamp.

app_urlstring uri required

Example response

{
  "id": "can_a1b2c3d4e5f64789a1b2c3d4e5f64789",
  "recruiter": {
    "id": "emp_a1b2c3d4e5f64789a1b2c3d4e5f64789"
  },
  "coordinator": {
    "id": "emp_a1b2c3d4e5f64789a1b2c3d4e5f64789"
  }
}