Skip to main content

​
Recruitment Campaign API

The Recruitment Campaign API manages the complete lifecycle of hiring campaigns — including creation, updating, viewing, deleting and fetching statistics. It also connects campaigns with candidate workflows such as screening, pre-screening forms, interview notes, and client notes. This API acts as the central hub that links profiles, candidates, interviews, and evaluation processes across the RMS.

​
Endpoints Overview

EndpointMethodDescriptionAccess
/api/campaignsGETGet all campaignscampaign:read
/api/campaigns/statsGETGet campaign statisticscampaign:read
/api/campaigns/:idGETGet a specific campaigncampaign:read
/api/campaignsPOSTCreate a new campaigncampaign:create
/api/campaigns/:idPUTUpdate campaign detailscampaign:update
/api/campaigns/:idDELETEDelete a campaigncampaign:delete
/api/campaigns/:idGETGet the public candidate application URL for this campaigncampaign:read

​
Detailed API Endpoints

​
GET /api/campaigns

Fetch all campaigns. 
GET /api/campaigns
Access: campaign:read

​
GET /api/campaigns/stats

Retrieve aggregated metrics for dashboards. 
GET /api/campaigns/stats
Access: campaign:read

​
GET /api/campaigns/:id

Get a single campaign with all details. 
GET /api/campaigns/:id
Access: campaign:read

​
POST /api/campaigns

Create a new recruitment campaign. 
POST /api/campaigns
Access: campaign:create
Validation: validateCampaign

​
PUT /api/campaigns/:id

Update an existing campaign. 
PUT /api/campaigns/:id
Access: campaign:update
Validation: validateCampaign

​
DELETE /api/campaigns/:id

Delete campaign by ID. 
DELETE /api/campaigns/:id
Access: campaign:delete
Returns the public candidate self-application URL generated using the campaign’s secure publicApplyToken. Access: campaign:read 
{
  "success": true,
  "data": {
    "campaignId": "679aa3fa2150442ce4c34435",
    "publicApplyUrl": "https://yourdomain.com/apply/6e9cf1a0bde2"
  }
}