Skip to main content

Applicants

API for managing applicants and screening lifecycle.

📄️Restore soft-deleted applicant

Clears the removed flag (sets status.removed = false) so the applicant reappears in list and search results with every preserved aspect intact. The inverse of DELETE. Find restore candidates with `GET /applicants?deletedOnly=true`. Idempotent — restoring an applicant who is not deleted is a no-op. Recruitment checks cancelled by the original delete are not revived (their emailed links are permanently dead); dispatch new checks after restoring if still needed. Mirrors `POST /workers/{workerId}/restore`.

📄️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. Filter by record recency with `updatedAfter` and/or `updatedBefore` (ISO 8601 instant, e.g. 2026-01-01T00:00:00Z, or a bare date 2026-01-01); `updatedAfter` is inclusive, `updatedBefore` is exclusive. Sort by `lastUpdated` (record last-modified time), e.g. `sort=lastUpdated:desc`. Soft-deleted applicants are excluded by default; pass `includeDeleted=true` to see them as well (admin / audit / recovery flows).