Skip to main content

Recruitment Candidates API

Summary​

Four native operations list candidates, return aggregate detail, change stage, and add notes.

Audience​

Developers, QA and support engineers, implementation partners, architects, and security reviewers.

Reference Content​

MethodRelative routeInput or output
GET/recruitment/candidatesArray of CandidateDto
GET/recruitment/candidates/{id}CandidateDetailDto
PATCH/recruitment/candidates/{id}/stageChangeCandidateStageInput
POST/recruitment/candidates/{id}/notesAddCandidateNoteInput

Candidate detail composes candidate data, applications, stage history, notes, document references, interviews, and offers. Lists use source-defined fixed limits rather than a public pagination contract. Candidate creation occurs through application endpoints and compatibility routes; no native administrative create, delete, merge, or archive operation exists.

Response and Errors​

Successful Result-based operations return their DTO directly. Confirmed failures map to 400 validation, 404 missing resource, or 409 conflict with a message object. Authorization-specific outcomes are not defined by these endpoints.

Requires confirmation​

Endpoint authorization, production exposure, privacy controls, ownership, operational limits, and compatibility parity require confirmation.

Source References​

  • microservices/src/recruitment-service/Api/RecruitmentEndpoints.cs
  • microservices/src/recruitment-service/Application/Dtos.cs
  • microservices/src/recruitment-service/Application/Commands/CandidateCommands.cs
  • microservices/src/recruitment-service/Application/Queries/RecruitmentQueries.cs

See Also​

Keywords​

  • Recruitment API
  • Source-backed endpoint reference

Revision Information​

  • Status: Draft
  • Last reviewed: 2026-07-16
  • Review cycle: Quarterly