Base URL https://api.cube-hr.co.uk/api/v1
13 endpoints
Job postings, candidates and CVs, the hiring pipeline, and converting a hire into an employee.
/recruitment/postings
List job postings for the company.
Create a posting. Postings default to draft; send status open to publish immediately, which also stamps published_at.
/recruitment/postings/{uuid}
Update a posting, including publishing it (status open) or closing it. Publishing stamps published_at the first time.
/recruitment/candidates
Add a candidate to the talent pool. GDPR consent is required.
/recruitment/candidates/{uuid}/cv
Upload or replace a candidate CV as multipart form data. PDF, Word, RTF or plain text, up to 10 MB. Replacing a CV removes the previous file.
Returns short-lived presigned URLs for the CV. The bucket is private, so the file itself is never served directly.
Removes the CV record and the stored file.
/recruitment/applications
List applications across all postings. employee_id is set once the application has been converted.
Creates an application at the applied stage for a candidate and posting.
/recruitment/applications/{uuid}/stage
Move an application to another stage. Moving to hired sets the status to hired; rejected and withdrawn record the reason and timestamp.
/recruitment/applications/{uuid}/convert
Creates the employee record from a hired application and links the two. Only a hired application can be converted, and it can only be converted once. A start date in the future creates the employee as a pending starter (status pending, excluded from headcount) who becomes active on their start date via the employees:activate-pending command. Name and email are taken from the candidate, and job title, department, hiring manager, employment type and salary currency default from the posting.
/recruitment/interviews
List scheduled interviews.
Schedule an interview against an application.