Departments
create
departments.create
Create a department with a name that is unique in the company
Risk: write
field_data full type
field_data full type
delete
departments.delete
Delete a department; TalentHR refuses while an active job position uses it
Risk: destructive · Irreversible
list
departments.list
List the departments of the company
Risk: read
object[]
Output full type
Output full type
Divisions
create
divisions.create
Create a division with a name that is unique in the company
Risk: write
field_data full type
field_data full type
delete
divisions.delete
Delete a division; TalentHR refuses while an active job position uses it, and clears it from other records
Risk: destructive · Irreversible
get
divisions.get
Read one division by ID
Risk: read
field_data full type
field_data full type
list
divisions.list
List the divisions of the company
Risk: read
object[]
Output full type
Output full type
update
divisions.update
Rename a division
Risk: write
field_data full type
field_data full type
Employees
delete
employees.delete
Permanently delete an employee; use terminate when the employment history must be kept
Risk: destructive · Irreversible
directory
employees.directory
List employees with their job, contact and org details, filtered and paged; the response carries the total match count
Risk: read
rows full type
rows full type
employmentStatuses
employees.employmentStatuses
List an employee’s employment status records, each with its effective date and status name
Risk: read
object[]
Output full type
Output full type
get
employees.get
Read one employee, including their user role, seniority, custom fields and manager
Risk: read
user_role full type
user_role full type
seniority full type
seniority full type
custom_fields full type
custom_fields full type
user full type
user full type
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
employment_status full type
employment_status full type
job_record full type
job_record full type
compensation_record full type
compensation_record full type
emergency_contact full type
emergency_contact full type
user_role full type
user_role full type
seniority full type
seniority full type
custom_fields full type
custom_fields full type
user full type
user full type
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
employment_status full type
employment_status full type
job_record full type
job_record full type
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
employment_status full type
employment_status full type
update
employees.update
Change an employee’s name, contact, address, SSN, birth date, manager or emergency contact
Risk: write
emergency_contact full type
emergency_contact full type
user_role full type
user_role full type
seniority full type
seniority full type
custom_fields full type
custom_fields full type
user full type
user full type
Job Titles
list
jobTitles.list
List the job titles of the company
Risk: read
object[]
Output full type
Output full type
Locations
list
locations.list
List the work locations with their address and whether they are remote
Risk: read
object[]
Output full type
Output full type
Reference Data
employmentStatuses
referenceData.employmentStatuses
List the employment statuses, whose IDs employees.hire and employees.rehire take
Risk: read
object[]
Output full type
Output full type
Time Off
budgets
timeOff.budgets
Read one employee’s time off budgets per type, including used and carried-over amounts
Risk: read
object[]
Output full type
Output full type
create
timeOff.create
Book time off for an employee, either preapproved or sent to their manager for approval by email
Risk: destructive
amountOptions full type
amountOptions full type
time_off_type full type
time_off_type full type
delete
timeOff.delete
Cancel a time off request, which frees its budget back to the employee
Risk: destructive
list
timeOff.list
List one employee’s time off requests with their type, dates, budget and approval state
Risk: read
rows full type
rows full type
reply
timeOff.reply
Approve or reject a time off request on behalf of the manager; TalentHR emails the employee the outcome
Risk: destructive
types
timeOff.types
List the time off types with their budgets, whether they are paid and whether they need approval
Risk: read
object[]
Output full type
Output full type