Referrals

Manage employee referrals for job openings.

Get All Referrals

GET/api/recruitment/referrals

Get all referrals with optional filters.

{ "referrals": [ { "id": "...", "employee": { "id": "...", "name": "John" }, "candidate": { "id": "...", "firstName": "Jane" }, "job": { "id": "...", "title": "Software Engineer" }, "referralId": "REF-001", "status": "pending", "referralBonusEligible": true } ] }

Create Referral

POST/api/recruitment/referrals

Create a new referral for a candidate.

FieldTypeRequiredDescription
firstNamestringRequiredCandidate first name
lastNamestringOptionalCandidate last name
emailstringRequiredCandidate email
phonestringOptionalCandidate phone
jobIdstringOptionalJob ID to refer for
sourcestringOptionalReferral source
{ "referral": { "id": "...", "referralId": "REF-002", "status": "pending" } }

Update Referral

PATCH/api/recruitment/referrals/[id]

Update referral status.

FieldTypeRequiredDescription
idstringRequiredReferral ID (path param)
statusstringRequiredNew status (pending/reviewed/hired/rejected)
{ "referral": { ... updated referral } }

Verify Referral

GET/api/public/jobs/[id]/verify-referral

Verify a referral ID is valid (public, no auth required).

Query ParamTypeRequiredDescription
referralIdstringRequiredReferral ID to verify
{ "valid": true }

Referral Statuses

StatusDescription
pendingReferral submitted, awaiting review
reviewedReferral has been reviewed
hiredCandidate was hired
rejectedCandidate was rejected