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
Soft delete — marks the applicant as removed (sets status.removed = true). Nothing is erased: the record, its properties and audit trail are preserved and can be recovered. Find removed applicants with `GET /applicants?deletedOnly=true`, then restore one with `POST /applicants/{applicantId}/restore`.
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`.
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. 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).
Create applicant
Create a new applicant. Server generates an opaque `app_<16chars>` ID; callers cannot supply it. Required fields: displayName, firstName, lastName, emailAddress.