Recruitment API

Manage the hiring pipeline — job requisitions, postings, candidates, interviews, and offers.

Requires: Recruitment module

Generic Resource Endpoints

Most recruitment resources follow a consistent pattern:

GET /api/recruitment/{resource}

List resources. Resource can be: job-requisitions, job-postings, candidates, interviews, interview-management-sessions, offers, talent-pool-candidates.

POST /api/recruitment/{resource}

Create a new resource.

GET /api/recruitment/{resource}/{id}

Get a specific resource.

PUT /api/recruitment/{resource}/{id}

Update a specific resource.

DELETE /api/recruitment/{resource}/{id}

Delete a specific resource.

Specialized Endpoints

POST /api/recruitment/candidates/{id}/convert-to-employee

Convert a hired candidate into a full employee record.

POST /api/recruitment/offers/{id}/send

Send an offer letter via email to a candidate.

POST /api/recruitment/offers/{id}/send-appointment

Send an appointment letter to an accepted candidate.

POST /api/recruitment/interview-management-sessions/{id}/send

Send an interview link to a candidate.

POST /api/recruitment/document-templates/preview-pdf

Preview a document template with merge fields as PDF.

AI Endpoints

POST /api/recruitment/ai/job-description

Generate a job description using AI.

Request Body:

{
  "title": "Senior Software Engineer",
  "department": "Engineering",
  "requirements": "5+ years experience, React, Node.js"
}

POST /api/recruitment/ai/resume-screening

Screen a resume against job requirements using AI.

POST /api/recruitment/ai/interview-questions

Generate interview questions based on job requirements.

POST /api/recruitment/ai/content

General AI content generation for recruitment purposes.