Jobzyn API
The Jobzyn API allows you to integrate your ATS or HR system with the Jobzyn job board. You can:
- Push job offers to Jobzyn so they appear on the platform
- Update or unpublish existing jobs using your own job IDs
- Retrieve candidates who applied to your jobs
Base URL
https://www.jobzyn.com/api/integrationsQuick Start
- Get your API key from the Jobzyn backoffice (Settings > API Keys)
- Send a
POSTrequest to create a job - Use the same job ID to update, unpublish, or retrieve candidates
curl -X POST https://www.jobzyn.com/api/integrations/job \
-H "Content-Type: application/json" \
-H "x-api-key: YOUR_API_KEY" \
-d '{
"job": {
"id": "YOUR-JOB-ID-123",
"title": "Software Engineer",
"description": "<p>We are looking for a software engineer...</p>",
"city": "Casablanca",
"country": "Maroc"
}
}'How It Works
Your system assigns each job a unique ID (the id field). Jobzyn stores this as externalId and uses it to link all operations together:
| Your action | Endpoint | Your job ID used as |
|---|---|---|
| Create a job | POST /job | id in the request body |
| Update a job | PUT /job/{id} | Path parameter |
| Unpublish a job | DELETE /job/{id} | Path parameter |
| Get candidates | GET /job/{id}/candidates | Path parameter |
Polling for New Candidates
Webhooks are not supported yet but are on the roadmap. In the meantime, use the since query parameter on the candidates endpoint to poll for new applications:
GET /job/{id}/candidates?since=2024-06-14T00:00:00ZThis returns only applications created after the given date, so you can poll periodically without re-fetching everything. See Get Candidates for full details.
Last updated on