Recruitment API
Create company records, open recruitment missions, and keep job descriptions synchronized from an external recruitment platform.
Auth
Apikey API key
Base path
/partners/v1
Companies
GET + POST /companies
Updates
PATCH /missions/:missionId
Start here
Authenticate each request with an API key.
The Recruitment API uses the documented Apikey authorization format. Bearer remains accepted by the platform for compatibility.
Missing or invalid credentials return 401 with a single error key. Every successful read or write is scoped to the authenticated partner account.
- Send Authorization: Apikey <apiKey> on every request.
- Use /partners/v1 for new integrations; /partners/hunteron/v1 remains available for HunterOn compatibility.
- Errors use { error: string } so integrations can show the partner-facing message directly.
- Company and mission lists only return records owned by the authenticated account.
Request contract
Headers, path parameters, and body fields used by this step.
Authorization
Header
Recruitment API key issued by CrossPath.
Content-Type
Header
Required for POST and PATCH request bodies.
Response contract
The documented response fields returned by CrossPath.
error
Response
Returned on 401, 400, 403, and 404 errors.
Error responses
Missing or invalid API key
401 { "error": "Please provide your API key." }
Non-owned company on mission create
400 { "error": "..." }
Non-owned mission on update
404 { "error": "This mission does not exist or you don't have the permission to update it." }
Private mission status update
403 { "error": "You can't update the status of a JD that is not Live." }
Payload view
Authentication headers
Header contract used by the Recruitment API
Authorization: Apikey Recruitment-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Content-Type: application/json
401 response:
{
"error": "Please provide your API key."
}JSON response preview
Representative response payload
{
"error": "Please provide your API key."
}Need access?
Request the Recruitment API key and field mapping.
CrossPath will issue the technical account, API key, and accepted reference values for sectors, locations, languages, positions, and company sizes.