TalentHR
App · 20 actions
Run HR in TalentHR: list, hire, update and terminate employees and record job changes, book, approve and cancel time off and see who's off, and move job applicants through hiring with notes.
Actions
| Action | What it does |
|---|---|
| Add application note | Add a note to a job application for the hiring team. |
| Approve or reject time off | Approve or reject a pending time off request. |
| Book time off | Book time off for an employee. |
| Cancel time off | Cancel an employee's approved time off. |
| Create job record | Record a promotion, transfer or change of department from a date: a new job title, location, division, department or work arrangement. |
| Get applicant | Get one candidate with every application they made, its hiring step, and a link to their latest CV (it expires). |
| Get employee | Get one employee's profile: contact details, job, manager, seniority and whether they have left. |
| Get time off balances | Get how much of each time off type an employee has, and how much they have used. |
| Get who's off | See who is off between two dates, with each pending or approved time off request, optionally for some locations, departments or divisions. |
| Hire employee | Add a new employee with their manager, employment status and job, and optionally email them an invitation. |
| List employees | List people in the company directory, optionally only those in some locations, departments, divisions or employment statuses. |
| List holidays | List the company's public holidays for a year. |
| List job applicants | List the people who applied to a job position. |
| List job positions | List job positions with their status, hiring steps and how many people applied, are in progress and were hired. |
| List job records | List an employee's job history: each job title, location, division and department, and when it took effect. |
| List time off requests | List an employee's time off requests, each with its status: pending, approved, rejected or canceled. |
| List time off types | List the company's time off types, such as Vacation or Sick Leave, with their allowance and whether they need approval. |
| Move application to step | Move a job application to another hiring step, such as interview or hired. |
| Terminate employee | End an employee's employment on a date, as a termination or a resignation. |
| Update employee | Change an employee's personal and contact details or manager. |
Add application note
Add a note to a job application for the hiring team.
Inputs
- Job position
job_position_idtextRequired - The job position. Pick one, or give its id from an earlier step.
- Application
application_idtextRequired - The application, picked by applicant. From an earlier step, use 'application.id' from 'List job applicants', not the applicant's id.
- Note
note_texttextRequired - The note, which the hiring team sees on the application.
Outputs
What the step returns
noteobject- The new note
Example output
{
"note": {
"applicant_id": 7,
"application_id": 11,
"commentor_full_name": "Mia Black",
"created_at": "2026-10-18 09:00:00",
"id": 88,
"job_position_id": 2,
"note_date": "2026-10-18",
"note_text": "Strong portfolio."
}
}Approve or reject time off
Approve or reject a pending time off request. TalentHR emails the employee the outcome.
Inputs
- Employee
employee_idtextRequired - The employee. Pick one, or give their id from an earlier step.
- Time off request
time_off_request_idtextRequired - A pending request of theirs, or its id from an earlier step.
- Decision
decisiontextRequired - TalentHR emails the employee the outcome.One of:
approve,reject.
Outputs
What the step returns
approvedtrue/false- True when approved
decisiontext- approve or reject
time_off_request_idnumber- The request answered
Example output
{
"approved": true,
"decision": "approve",
"time_off_request_id": 2402
}Book time off
Book time off for an employee. It goes to their manager to approve unless you approve it now.
Inputs
- Employee
employee_idtextRequired - The employee. Pick one, or give their id from an earlier step.
- Time off type
time_off_type_idtextRequired - Such as Vacation or Sick Leave.
- First day off
start_datedateRequired - Within a year of today.
- Last day off
end_datedate - Leave blank for a single day.
- Note
notetext - A note for the approver, up to 255 characters.
- Approve it now
preapprovedtrue/false - Book it as approved, where you may approve it. Leave off to send it to their manager, who is emailed to approve it.Default:
false.
Outputs
What the step returns
time_off_requestobject- The new time off request
time_off_request_idnumber- The new request's id
Example output
{
"time_off_request": {
"approved": true,
"budget": "1.000",
"budget_days": "1.000",
"created_at": "2026-10-18 09:00:00",
"employee_id": 15,
"end_date": "2026-11-02",
"id": 2402,
"start_date": "2026-11-02",
"time_off_type": {
"id": 1,
"name": "Vacation",
"slug": "vacation"
},
"timeoff_type_id": 1
},
"time_off_request_id": 2402
}Cancel time off
Cancel an employee's approved time off. Pending and rejected requests cannot be canceled.
Inputs
- Employee
employee_idtextRequired - The employee. Pick one, or give their id from an earlier step.
- Time off request
time_off_request_idtextRequired - An approved request of theirs, or its id from an earlier step. Pending and rejected requests cannot be canceled.
Outputs
What the step returns
canceledtrue/false- Always true
time_off_request_idnumber- The canceled request
Example output
{
"canceled": true,
"time_off_request_id": 2402
}Create job record
Record a promotion, transfer or change of department from a date: a new job title, location, division, department or work arrangement.
Inputs
- Employee
employee_idtextRequired - The employee. Pick one, or give their id from an earlier step.
- Effective date
effective_datedateRequired - When the change takes effect: on or after their hire date, and before any termination.
- Job title
job_title_idtext - Their new job title.
- Location
location_idtext - Their new location.
- Division
division_idtext - Their new division.
- Department
department_idtext - Their new department.
- Work arrangement
employment_typetext - Where they work from.One of:
On-site,Hybrid,Remote.
Outputs
What the step returns
job_recordobject- The new job record
Example output
{
"job_record": {
"created_at": "2026-10-01 09:00:00",
"department": {
"id": 6,
"name": "Operations"
},
"department_id": 6,
"division": {
"id": 13,
"name": "Europe"
},
"division_id": 13,
"effective_date": "2026-10-01",
"employee_id": 15,
"employment_type": "Hybrid",
"end_date": "",
"id": 31,
"job_title": {
"id": 25,
"name": "Office Manager"
},
"job_title_id": 25,
"location": {
"id": 36,
"name": "Athens"
},
"location_id": 36
}
}Get applicant
Get one candidate with every application they made, its hiring step, and a link to their latest CV (it expires).
Inputs
- Applicant ID
applicant_idtextRequired - The applicant's id, from 'List job applicants'.
Outputs
What the step returns
applicantobject- The applicant
Example output
{
"applicant": {
"address": "",
"applications": [
{
"application_step": {
"id": 1,
"is_enabled": 1,
"name": "Applied",
"slug": "applied",
"sort_order": 1
},
"application_step_id": 1,
"application_step_slug": "applied",
"id": 11,
"job_position_id": 2
}
],
"applications_count": 1,
"created_at": "2026-10-10 09:00:00",
"description": "",
"email": "sam@example.com",
"first_name": "Sam",
"id": 7,
"last_name": "Rivera",
"latest_application_id": 11,
"latest_cv": {
"client_filename": "cv.pdf",
"cv_url": "https://example.com/cv.pdf",
"filetype": "pdf",
"id": 5
},
"phone": "",
"starred": false
}
}Get employee
Get one employee's profile: contact details, job, manager, seniority and whether they have left.
Inputs
- Employee
employee_idtextRequired - The employee. Pick one, or give their id from an earlier step.
Outputs
What the step returns
employeeobject- The employee's profile
Example output
{
"employee": {
"address": "",
"birth_date": "1990-05-30",
"citizenship": "",
"city": "Athens",
"country": "Greece",
"department_id": 6,
"department_name": "Operations",
"division_id": 13,
"division_name": "Europe",
"employee_number": "",
"gender": "",
"hire_date": "2026-01-05",
"id": 15,
"is_terminated": false,
"job_title_id": 25,
"job_title_name": "Office Manager",
"linked_in_url": "",
"location_id": 36,
"location_name": "Athens",
"marital_status": "",
"nationality": "",
"personal_email": "",
"photo_url": "",
"postal_code": "",
"seniority": {
"days": 13,
"months": 9,
"years": 0
},
"short_manager": {
"department_name": "Operations",
"email": "mia@example.com",
"job_title_name": "Chief Executive Officer",
"location_name": "Athens",
"manager_id": 1,
"manager_name": "Mia Black"
},
"termination_date": "",
"termination_reason": "",
"user": {
"email": "jo@example.com",
"first_name": "Jo",
"last_login_at": "",
"last_name": "Bloggs",
"middle_name": ""
},
"user_role": {
"id": 3,
"name": "Employee",
"slug": "employee"
},
"work_phone": "+30 210 000 0000"
}
}Get time off balances
Get how much of each time off type an employee has, and how much they have used. Amounts are in days, as text such as 10.000.
Inputs
- Employee
employee_idtextRequired - The employee. Pick one, or give their id from an earlier step.
- Current cycle only
current_cycle_onlytrue/false - Only the time off year running now. Turn off to include past and future cycles.Default:
true. - Time off cycle ID
time_off_cycle_idtext - One cycle's balances, by the 'time_off_cycle_id' an earlier balance shows. Overrides the setting above.
Outputs
What the step returns
balanceslist- One balance per time off type
countnumber- How many were returned
Example output
{
"balances": [
{
"budget": "18.000",
"employee_id": 15,
"has_unlimited_timeoff": false,
"id": 90,
"original_budget": "20.000",
"paid": true,
"time_off_cycle_id": 4,
"timeoff_allow_exceeding": false,
"timeoff_type_id": 1,
"timeoff_type_name": "Vacation",
"timeoff_type_slug": "vacation",
"used_budget": "2.000"
}
],
"count": 1
}Get who's off
See who is off between two dates, with each pending or approved time off request, optionally for some locations, departments or divisions.
Inputs
- From
start_datedateRequired - The first day to look at.
- To
end_datedate - The last day to look at, within two years. Leave blank for the end of the first day's month.
- Employee
employee_idtext - Only this person.
- Request statuses
time_off_statuseslist - Only time off with these statuses. Leave blank for both.One or more of:
approved,pending. - Locations
location_idslist - Only people at these locations.
- Departments
department_idslist - Only people in these departments.
- Divisions
division_idslist - Only people in these divisions.
- Include people not off
include_everyonetrue/false - Also list everyone with no time off in the period.Default:
false.
Outputs
What the step returns
countnumber- How many were returned
employeeslist- The people off
time_offlist- Each request in the period
Example output
{
"count": 1,
"employees": [
{
"department": "Operations",
"division": "Europe",
"email": "jo@example.com",
"first_name": "Jo",
"id": 15,
"job_title": "Office Manager",
"last_name": "Bloggs",
"location_id": 36,
"time_off_request": [
{
"approved": true,
"end_date": "2026-11-02",
"id": 2402,
"start_date": "2026-11-02",
"time_off_type": {
"id": 1,
"name": "Vacation",
"slug": "vacation"
}
}
]
}
],
"time_off": [
{
"approved": true,
"budget": "1.000",
"email": "jo@example.com",
"employee_id": 15,
"end_date": "2026-11-02",
"first_name": "Jo",
"id": 2402,
"last_name": "Bloggs",
"start_date": "2026-11-02",
"status": "approved",
"time_off_type": {
"id": 1,
"name": "Vacation",
"slug": "vacation"
},
"timeoff_type_id": 1
}
]
}Hire employee
Add a new employee with their manager, employment status and job, and optionally email them an invitation.
Inputs
- First name
first_nametextRequired - Their first name.
- Last name
last_nametextRequired - Their last name.
- Work email
emailtextRequired - The email they sign in to TalentHR with. It must not belong to anyone else in TalentHR.
- Hire date
hire_datedateRequired - Their first day.
- Manager
reports_to_employee_idtextRequired - Who they report to.
- Employment status
employment_status_idtextRequired - Such as Full-Time, Part-Time or Contractor.
- Job title
job_title_idtext - The job title.
- Location
location_idtext - The location they work from.
- Division
division_idtext - The division.
- Department
department_idtext - The department.
- Send invitation email
send_invitationtrue/false - Email them an invitation to sign in to TalentHR.Default:
true. - Already works here
is_existingtrue/false - Turn on for someone who already works for you, so TalentHR skips its automatic onboarding. Leave off for a new hire.Default:
false.
Outputs
What the step returns
employeeobject- The new employee
employee_idnumber- The new employee's id
Example output
{
"employee": {
"address": "",
"birth_date": "1990-05-30",
"citizenship": "",
"city": "Athens",
"country": "Greece",
"department_id": 6,
"department_name": "Operations",
"division_id": 13,
"division_name": "Europe",
"employee_number": "",
"gender": "",
"hire_date": "2026-01-05",
"id": 15,
"is_terminated": false,
"job_title_id": 25,
"job_title_name": "Office Manager",
"linked_in_url": "",
"location_id": 36,
"location_name": "Athens",
"marital_status": "",
"nationality": "",
"personal_email": "",
"photo_url": "",
"postal_code": "",
"seniority": {
"days": 13,
"months": 9,
"years": 0
},
"short_manager": {
"department_name": "Operations",
"email": "mia@example.com",
"job_title_name": "Chief Executive Officer",
"location_name": "Athens",
"manager_id": 1,
"manager_name": "Mia Black"
},
"termination_date": "",
"termination_reason": "",
"user": {
"email": "jo@example.com",
"first_name": "Jo",
"last_login_at": "",
"last_name": "Bloggs",
"middle_name": ""
},
"user_role": {
"id": 3,
"name": "Employee",
"slug": "employee"
},
"work_phone": "+30 210 000 0000"
},
"employee_id": 15
}List employees
List people in the company directory, optionally only those in some locations, departments, divisions or employment statuses.
Inputs
- Locations
location_idslist - Only people at these locations.
- Departments
department_idslist - Only people in these departments.
- Divisions
division_idslist - Only people in these divisions.
- Employment statuses
employment_status_idslist - Only people with these statuses, such as Full-Time.
- Maximum results
max_resultsnumber - How many to return, 1 to 1000. Defaults to 100.From 1 to 1000.
- Skip
offsetnumber - How many people to skip, to read on from an earlier step's 'next_offset'.At least 0.
Outputs
What the step returns
countnumber- How many were returned
employeeslist- The employees
next_offsetnumber- Give as 'Skip' to read on; empty at the end
totalnumber- How many TalentHR has in all
Example output
{
"count": 1,
"employees": [
{
"address": "",
"city": "Athens",
"country": "Greece",
"department": "Operations",
"department_id": 6,
"division": "Europe",
"division_id": 13,
"email": "jo@example.com",
"employment_status_id": 1,
"employment_status_name": "Full-Time",
"first_name": "Jo",
"hire_date": "2026-01-05",
"id": 15,
"job_title": "Office Manager",
"job_title_id": 25,
"last_name": "Bloggs",
"linked_in_url": "",
"location": "Athens",
"location_id": 36,
"photo_url": "https://example.com/jo.jpg",
"postal_code": "",
"reports_to_employee_id": 1,
"termination_date": "",
"user_id": 20,
"user_role": {
"id": 3,
"name": "Employee",
"slug": "employee"
},
"work_phone": "+30 210 000 0000"
}
],
"next_offset": null,
"total": 1
}List holidays
List the company's public holidays for a year.
Inputs
- Year
yearnumber - Defaults to this year.From 1970 to 2100.
Outputs
What the step returns
countnumber- How many were returned
holidayslist- The holidays
Example output
{
"count": 1,
"holidays": [
{
"holiday_date": "2026-12-25",
"id": 3,
"name": "Christmas Day",
"required_for_all": true
}
]
}List job applicants
List the people who applied to a job position. Each has an 'application' whose id the hiring-step and note actions take.
Inputs
- Job position
job_position_idtextRequired - The job position. Pick one, or give its id from an earlier step.
- Search
searchtext - Matches first names, last names and emails.
- Sort by
sorttext - The order to list them in.One of:
created_at(Date applied),name. - Direction
ordertext - Which end of the order comes first.One of:
desc(Newest or Z first),asc(Oldest or A first). - Maximum results
max_resultsnumber - How many to return, 1 to 1000. Defaults to 100.From 1 to 1000.
Outputs
What the step returns
applicantslist- The applicants
countnumber- How many were returned
totalnumber- How many TalentHR has in all
Example output
{
"applicants": [
{
"added_at": "2026-10-10 09:00:00",
"address": "",
"application": {
"applicant_id": 7,
"application_step_id": 1,
"created_at": "2026-10-10 09:00:00",
"id": 11,
"is_disqualified": false,
"job_position_id": 2
},
"created_at": "2026-10-10 09:00:00",
"email": "sam@example.com",
"first_name": "Sam",
"id": 7,
"last_name": "Rivera",
"phone": "",
"starred": false
}
],
"count": 1,
"total": 1
}List job positions
List job positions with their status, hiring steps and how many people applied, are in progress and were hired.
Inputs
None.
Outputs
What the step returns
countnumber- How many were returned
job_positionslist- The job positions
Example output
{
"count": 1,
"job_positions": [
{
"applied_count": 1,
"available_steps": [
{
"id": 1,
"is_enabled": 1,
"name": "Applied",
"slug": "applied",
"sort_order": 1
}
],
"city": "Athens",
"country": "GR",
"department_name": "Operations",
"employment_status_name": "Full-Time",
"employment_type": "Hybrid",
"end_date": "",
"has_applications": true,
"hired_count": 0,
"id": 2,
"is_remote": false,
"job_position_status_name": "Published",
"job_position_status_slug": "published",
"job_position_title": "Office Manager",
"location_name": "Athens",
"processed_count": 0,
"publish_date": "2026-09-01 09:00:00",
"slug": "office-manager"
}
]
}List job records
List an employee's job history: each job title, location, division and department, and when it took effect.
Inputs
- Employee
employee_idtextRequired - The employee. Pick one, or give their id from an earlier step.
Outputs
What the step returns
countnumber- How many were returned
job_recordslist- The job records
Example output
{
"count": 1,
"job_records": [
{
"created_at": "2026-10-01 09:00:00",
"department": {
"id": 6,
"name": "Operations"
},
"department_id": 6,
"division": {
"id": 13,
"name": "Europe"
},
"division_id": 13,
"effective_date": "2026-10-01",
"employee_id": 15,
"employment_type": "Hybrid",
"end_date": "",
"id": 31,
"job_title": {
"id": 25,
"name": "Office Manager"
},
"job_title_id": 25,
"location": {
"id": 36,
"name": "Athens"
},
"location_id": 36
}
]
}List time off requests
List an employee's time off requests, each with its status: pending, approved, rejected or canceled.
Inputs
- Employee
employee_idtextRequired - The employee. Pick one, or give their id from an earlier step.
- Status
statustext - Only requests with this status.One of:
all(All (default)),pending,approved,rejected,canceled. - Sort by
sorttext - The order to list them in.One of:
id(Request id (default)),created_at(Date requested),timeoff_type_name(Time off type). - Maximum results
max_resultsnumber - How many to return, 1 to 1000. Defaults to 100.From 1 to 1000.
Outputs
What the step returns
countnumber- How many were returned
time_off_requestslist- The requests
totalnumber- How many TalentHR has in all
Example output
{
"count": 1,
"time_off_requests": [
{
"approved": true,
"budget": "1.000",
"created_at": "2026-10-18 09:00:00",
"employee_id": 15,
"end_date": "2026-11-02",
"id": 2402,
"is_canceled": false,
"note": "",
"start_date": "2026-11-02",
"status": "approved",
"timeoff_type_id": 1,
"timeoff_type_name": "Vacation"
}
],
"total": 1
}List time off types
List the company's time off types, such as Vacation or Sick Leave, with their allowance and whether they need approval.
Inputs
- Include turned-off types
include_disabledtrue/false - Also list types that are switched off.Default:
false.
Outputs
What the step returns
countnumber- How many were returned
time_off_typeslist- The time off types
Example output
{
"count": 1,
"time_off_types": [
{
"allow_exceeding": false,
"budget": "20.000",
"id": 1,
"is_default": true,
"is_disabled": false,
"name": "Vacation",
"needs_approval": true,
"paid": true,
"period": "year",
"slug": "vacation",
"use_calendar_days": false
}
]
}Move application to step
Move a job application to another hiring step, such as interview or hired.
Inputs
- Job position
job_position_idtextRequired - The job position. Pick one, or give its id from an earlier step.
- Application
application_idtextRequired - The application, picked by applicant. From an earlier step, use 'application.id' from 'List job applicants', not the applicant's id.
- Step
step_slugtextRequired - The hiring step to move it to, from the position's enabled steps (applied, promising, phone-screen, interview or hired by default).
Outputs
What the step returns
application_idnumber- The application moved
movedtrue/false- Always true
step_slugtext- The step it is now in
Example output
{
"application_id": 11,
"moved": true,
"step_slug": "interview"
}Terminate employee
End an employee's employment on a date, as a termination or a resignation. Their direct reports move to their manager.
Inputs
- Employee
employee_idtextRequired - The employee. Pick one, or give their id from an earlier step.
- Last day
effective_datedateRequired - The date the employment ends. TalentHR removes records dated after it, such as booked time off.
- Type
termination_typetext - Whether you ended it or they resigned. Defaults to termination.One of:
termination(Termination (default)),resignation. - Reason
termination_reasontext - Why the employment ended, for your records.
- Regrettable
regrettabletrue/false - Mark it as a departure you would rather have avoided.Default:
false.
Outputs
What the step returns
terminationobject- The employment status record the termination created
Example output
{
"termination": {
"created_at": "2026-10-18 09:00:00",
"effective_date": "2026-10-31",
"employee_id": 15,
"employment_status": {
"id": 4,
"name": "Terminated"
},
"employment_status_id": 4,
"id": 40,
"regrettable_status": "",
"termination_reason": "Moved abroad",
"termination_type": "resignation"
}
}Update employee
Change an employee's personal and contact details or manager. Fields left blank keep their current values.
Inputs
- Employee
employee_idtextRequired - The employee. Pick one, or give their id from an earlier step.
- First name
first_nametext - A new first name. Leave blank to keep it.
- Last name
last_nametext - A new last name. Leave blank to keep it.
- Work email
emailtext - A new work email, which they sign in with.
- Personal email
personal_emailtext - Their personal email.
- Work phone
work_phonetext - Their work phone number.
- Mobile phone
mobile_phonetext - Their mobile phone number.
- Date of birth
birth_datedate - Their date of birth.
- Gender
gendertext - Their gender.One of:
Male,Female,Non-binary. - Marital status
marital_statustext - Their marital status.One of:
Single,Married,Separated,Widowed. - Address
addresstext - Their street address.
- City
citytext - Their city.
- Postal code
postal_codetext - Their postal code.
- Country
countrytext - Their country, written as TalentHR lists it on the employee's profile, such as Greece.
- Manager
reports_to_employee_idtext - A new manager. Leave blank to keep the current one.
- Employee number
employee_numbertext - Your own reference number for them.
- LinkedIn profile
linked_in_urltext - The address of their LinkedIn profile.
Outputs
What the step returns
employeeobject- The employee, as updated
Example output
{
"employee": {
"address": "",
"birth_date": "1990-05-30",
"citizenship": "",
"city": "Athens",
"country": "Greece",
"department_id": 6,
"department_name": "Operations",
"division_id": 13,
"division_name": "Europe",
"employee_number": "",
"gender": "",
"hire_date": "2026-01-05",
"id": 15,
"is_terminated": false,
"job_title_id": 25,
"job_title_name": "Office Manager",
"linked_in_url": "",
"location_id": 36,
"location_name": "Athens",
"marital_status": "",
"nationality": "",
"personal_email": "",
"photo_url": "",
"postal_code": "",
"seniority": {
"days": 13,
"months": 9,
"years": 0
},
"short_manager": {
"department_name": "Operations",
"email": "mia@example.com",
"job_title_name": "Chief Executive Officer",
"location_name": "Athens",
"manager_id": 1,
"manager_name": "Mia Black"
},
"termination_date": "",
"termination_reason": "",
"user": {
"email": "jo@example.com",
"first_name": "Jo",
"last_login_at": "",
"last_name": "Bloggs",
"middle_name": ""
},
"user_role": {
"id": 3,
"name": "Employee",
"slug": "employee"
},
"work_phone": "+30 210 000 0000"
}
}