Referrals
Manage employee referrals for job openings.
Get All Referrals
GET
/api/recruitment/referralsGet 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/referralsCreate a new referral for a candidate.
| Field | Type | Required | Description |
|---|---|---|---|
firstName | string | Required | Candidate first name |
lastName | string | Optional | Candidate last name |
email | string | Required | Candidate email |
phone | string | Optional | Candidate phone |
jobId | string | Optional | Job ID to refer for |
source | string | Optional | Referral source |
{
"referral": {
"id": "...",
"referralId": "REF-002",
"status": "pending"
}
}
Update Referral
PATCH
/api/recruitment/referrals/[id]Update referral status.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Required | Referral ID (path param) |
status | string | Required | New status (pending/reviewed/hired/rejected) |
{
"referral": { ... updated referral }
}
Verify Referral
GET
/api/public/jobs/[id]/verify-referralVerify a referral ID is valid (public, no auth required).
| Query Param | Type | Required | Description |
|---|---|---|---|
referralId | string | Required | Referral ID to verify |
{
"valid": true
}
Referral Statuses
| Status | Description |
|---|---|
pending | Referral submitted, awaiting review |
reviewed | Referral has been reviewed |
hired | Candidate was hired |
rejected | Candidate was rejected |