Applicants

API for managing applicants and screening lifecycle.

📄️Get applicant

Fetch a single applicant by ID. Pass `include=credentials` to embed a summary of submitted credentials in the response (capped at 50). Otherwise the credentials array is omitted entirely.

📄️Replace applicant

Wholesale replace of properties.

📄️Soft delete applicant

Marks applicant as removed.

📄️Partially update applicant

Apply a partial update.

📄️List applicants

Search and filter applicants. Use `query` for free-text search, `externalId` to look up by ATS identifier, or `status` to filter by lifecycle state. Soft-deleted applicants are excluded by default; pass `includeDeleted=true` to see them as well (admin / audit / recovery flows).

📄️Create applicant

Create a new applicant. Server generates an opaque `app_<16chars>` ID; callers cannot supply it. Required fields: displayName, firstName, lastName, emailAddress.