talenthr_list_employees
List employees (directory)
List the company's employees from the TalentHR directory with name, e-mail, job title, department, division, location, employment status, manager id, hire date and phone. Paged (limit max 100): use next_offset to continue. Filter by location, department, division or employment status (emp_state) with `filter`; get the ids from talenthr_get_directory_filters. Use `custom_fields` to add extra field slugs (from the company's custom fields). Returns personal data; summarize only what the user asked for.
Parameterslimitfilteroffsetcustom_fields
talenthr_get_directory_filters
Get directory filters
List the valid filter options (departments, divisions, locations, employment statuses) with their ids, to build the `filter` argument of talenthr_list_employees and talenthr_get_calendar.
Takes no parameters.
talenthr_get_employee
Get an employee
Get one employee's profile: birth date, hire and termination date, personal e-mail, work phone, address, nationality, gender, job title, department, division, location, role, seniority and custom fields. Contains sensitive personal data (it can include the SSN); only fetch it when the user asked about that person.
Parametersemployee_idrequired
talenthr_get_employee_job
Get an employee's job history
Get one employee's job information: employment status history, manager records, job records (title, department, location over time), compensation records and benefits. Compensation is sensitive; only fetch it when the user asked.
Parametersemployee_idrequired
talenthr_get_organization_chart
Get the organization chart
List all current employees with their manager (reports_to_employee_id), job title and role, to answer who reports to whom.
Takes no parameters.
talenthr_list_departments
List departments
List all departments of the company with their ids (the ids are what talenthr_list_employees filters and employee records refer to).
Takes no parameters.
talenthr_list_divisions
List divisions
List all divisions of the company with their ids (the ids are what talenthr_list_employees filters and employee records refer to).
Takes no parameters.
talenthr_list_locations
List locations
List all locations (with address and remote flag) of the company with their ids (the ids are what talenthr_list_employees filters and employee records refer to).
Takes no parameters.
talenthr_list_job_titles
List job titles
List all job titles of the company with their ids (the ids are what talenthr_list_employees filters and employee records refer to).
Takes no parameters.
talenthr_list_time_off_types
List time off types
List the time off types (vacation, sick leave, ...) with id, yearly budget, whether approval is needed and whether it is paid. The id is needed to book a request with talenthr_create_time_off_request.
Takes no parameters.
talenthr_list_employee_time_off_requests
List an employee's time off requests
List one employee's time off requests (dates, type, days, approved or pending, canceled). Paged: use next_offset to continue. A request with approved=null is still pending.
Parameterssortlimitoffsetemployee_idrequired
talenthr_get_employee_time_off_budgets
Get an employee's time off balances
Get one employee's time off budgets per type and cycle: budget, original budget, used days and accrual figures, i.e. how many days they have left. Optionally limit to the current cycle (active) or one cycle id.
Parametersactiveemployee_idrequiredtime_off_cycle_id
talenthr_get_calendar
Get the time off calendar
Who is off when: employees with their time off requests and the holidays for a date range. Without end_date the range runs to the end of the start month (max 2 years). Without a filter it includes every employee (also terminated). Filter with keys time_off (pending, approved), department, division, location, emp_state and time_off_type (e.g. time_off=pending,approved;department=6), or one employee with employee_id.
Parametersfilterend_datestart_daterequiredemployee_id
talenthr_list_holidays
List holidays
List the company holidays of a year (current year by default) with date and who they apply to.
Parametersyear
talenthr_list_benefits
List benefits
List the company's benefits with category, cost, dates and who they are required for. Optional `filter` with keys location, department, division, job_title, emp_state and employee (e.g. location=36;emp_state=1,2).
Parametersfilter
talenthr_get_employee_benefits
Get an employee's benefits
List the benefits one employee has (category, cost, start and end date).
Parametersemployee_idrequired
talenthr_list_assets
List company assets
List the company's assets (laptops, phones, subscriptions, memberships) with status, category, serial number, cost, purchase and warranty dates. Paged: use next_offset to continue. `search` matches name, description or category; `filter` takes status and category ids (e.g. status=1,2;category=19).
Parameterssortlimitorderfilteroffsetsearch
talenthr_get_employee_assets
Get an employee's assets
List the assets (inventory and memberships) assigned to one employee. Paged: use next_offset to continue.
Parameterssortlimitorderoffsetemployee_idrequired
talenthr_list_job_positions
List job positions
List the company's job positions (open and closed) with title, status, location, department, publish date and the hiring steps. The id is used to list a position's applicants.
Takes no parameters.
talenthr_list_job_position_applicants
List applicants of a job position
List the applicants of one job position with contact data, current hiring step and whether they are disqualified. Paged: use next_offset to continue. `search` matches first name, last name and e-mail.
Parameterssortlimitorderoffsetsearchjob_position_idrequired
talenthr_list_applicants
List all applicants
List every candidate across all job positions with contact data and the number of applications. Paged: use next_offset to continue. `search` matches first name, last name and e-mail; `starred_only` returns only the starred candidates (the talent pool).
Parameterssortlimitorderoffsetsearchstarred_only
talenthr_get_applicant
Get an applicant
Get one candidate with contact data, description, CV info and all applications with the hiring step each one is in. The application ids are used by talenthr_create_applicant_note.
Parametersapplicant_idrequired
talenthr_get_headcount_report
Get the headcount report
Headcount per month over a period (total and optionally grouped by gender, location, department, division, ...), plus the current headcount.
Parametersfilterperiodend_dategroup_bystart_date
talenthr_get_hires_leaves_report
Get the hires and leaves report
Hires, terminations and attrition rate per month over a period.
Parametersfilterperiodend_datestart_date
talenthr_get_time_off_report
Get the time off report
Approved, non-canceled time off summarized per month and per weekday, split by time off type, for a period.
Parametersfilterperiodend_datestart_date
talenthr_list_time_tracking_entries
List time tracking entries
List time tracking entries across all employees (start, end, duration, tags) for a period or date range. Paged: use next_offset to continue. working_now=true lists only running timers. Needs a key whose user may see everyone's time tracking.
Parameterssortlimitorderfilteroffsetperiodsearchend_datestart_dateworking_now
talenthr_create_time_off_request
Book a time off request
WRITE: book a time off request for an employee (talenthr_list_time_off_types gives the type id). Unless preapproved=true, TalentHR automatically E-MAILS THE EMPLOYEE'S MANAGER to approve or reject it. preapproved=true auto-approves it when the key's user is allowed to (so no manager decides): only use it when the user explicitly said the time off is already approved. Dates must be within one year from today and inside a time off cycle. Optionally give amount_options (days per date: 1, 0.5, 0 for non-working days; every date from start to end needs a value); when omitted TalentHR works it out. Cannot be undone through this server.
Parametersnoteend_daterequiredstart_daterequiredemployee_idrequiredpreapprovedamount_optionstimeoff_type_idrequired
talenthr_reply_time_off_request
Approve or reject a time off request
WRITE: approve (accept=true) or reject (accept=false) a pending time off request. TalentHR automatically E-MAILS THE EMPLOYEE the decision. A request that was already answered or canceled cannot be answered again. Only do this when the user explicitly asked for that decision on that request (find ids with talenthr_list_employee_time_off_requests or talenthr_get_calendar).
Parametersacceptrequiredemployee_idrequiredtime_off_request_idrequired
talenthr_create_applicant_note
Add a note to a job application
WRITE: add an internal note to a job application (visible to the hiring team in TalentHR; no one is e-mailed). Needs the job position id and the application id (talenthr_get_applicant lists an applicant's applications with their job_position_id). Notes cannot be edited or deleted through this server.
Parametersnote_textrequiredapplication_idrequiredjob_position_idrequired