Skip to main content
New to Corsair? See API access, authentication, and error handling.

Departments

create

departments.create Create a department with a name that is unique in the company Risk: write
Input Output

delete

departments.delete Delete a department; TalentHR refuses while an active job position uses it Risk: destructive · Irreversible
Input TalentHR refuses the delete while an active job position uses the department. Output

list

departments.list List the departments of the company Risk: read
Input: empty object Output: object[]

Divisions

create

divisions.create Create a division with a name that is unique in the company Risk: write
Input Output

delete

divisions.delete Delete a division; TalentHR refuses while an active job position uses it, and clears it from other records Risk: destructive · Irreversible
Input TalentHR refuses the delete while an active job position uses the division. Output

get

divisions.get Read one division by ID Risk: read
Input Output

list

divisions.list List the divisions of the company Risk: read
Input: empty object Output: object[]

update

divisions.update Rename a division Risk: write
Input Output

Employees

delete

employees.delete Permanently delete an employee; use terminate when the employment history must be kept Risk: destructive · Irreversible
Input Output

directory

employees.directory List employees with their job, contact and org details, filtered and paged; the response carries the total match count Risk: read
Input limit defaults to 10 and caps at 100; filter takes field:id pairs separated by commas, with IDs from the directory filters endpoint. Output

employmentStatuses

employees.employmentStatuses List an employee’s employment status records, each with its effective date and status name Risk: read
Input Output: object[]

get

employees.get Read one employee, including their user role, seniority, custom fields and manager Risk: read
Input Output

hire

employees.hire Create an employee with a hire date, employment status and optional job, pay and emergency contact records; TalentHR emails the new employee unless prevent_email is set Risk: destructive
Input reports_to_employee_id is required and accepts null for the head of the company; prevent_email stops the welcome email.
Output

rehire

employees.rehire Return a terminated employee to active status from a new hire date, with a manager and employment status; TalentHR sends a rehire email unless prevent_email is set Risk: destructive
Input hire_date must fall after the latest termination date, and reports_to_employee_id must be an active employee.
Output

terminate

employees.terminate Terminate an employee from a given date, recording the reason and whether the departure was regrettable; TalentHR emails the people given offboarding tasks Risk: destructive
Input effective_date must be YYYY-MM-DD; termination_reason accepts up to 4000 characters. Output

update

employees.update Change an employee’s name, contact, address, SSN, birth date, manager or emergency contact Risk: write
Input
Output

Job Titles

list

jobTitles.list List the job titles of the company Risk: read
Input: empty object Output: object[]

Locations

list

locations.list List the work locations with their address and whether they are remote Risk: read
Input: empty object Output: object[]

Reference Data

employmentStatuses

referenceData.employmentStatuses List the employment statuses, whose IDs employees.hire and employees.rehire take Risk: read
Input: empty object Output: object[]

Time Off

budgets

timeOff.budgets Read one employee’s time off budgets per type, including used and carried-over amounts Risk: read
Input Output: object[]

create

timeOff.create Book time off for an employee, either preapproved or sent to their manager for approval by email Risk: destructive
Input The route is multipart/form-data; amountOptions is sent as a JSON string and must cover every day from start_date through end_date.
Output

delete

timeOff.delete Cancel a time off request, which frees its budget back to the employee Risk: destructive
Input Output

list

timeOff.list List one employee’s time off requests with their type, dates, budget and approval state Risk: read
Input Output

reply

timeOff.reply Approve or reject a time off request on behalf of the manager; TalentHR emails the employee the outcome Risk: destructive
Input accept is a boolean: true approves, false rejects. Output

types

timeOff.types List the time off types with their budgets, whether they are paid and whether they need approval Risk: read
Input: empty object Output: object[]