People HR
App · 20 actions
Manage People HR employee records, holidays, absences, late records and holiday entitlements, read salaries and run saved queries.
Actions
| Action | What it does |
|---|---|
| Add a late record | Record that an employee was late on a day. |
| Book a holiday | Book holiday for an employee. |
| Create an employee | Add an employee to People HR. |
| Delete a holiday | Delete an employee's holiday booking. |
| Delete a late record | Delete an employee's late record for one day. |
| Delete an absence | Delete an employee's absence. |
| Get an employee | Read one employee's People HR record. |
| Get holiday entitlement | Read an employee's holiday entitlement for each holiday year, in days or hours as your company measures it. |
| Get salary | Read an employee's current salary, optionally with history. |
| List an employee's absences | List one employee's absences. |
| List an employee's holidays | List one employee's holiday bookings. |
| List an employee's late records | List the days one employee was late, and by how much. |
| List employees | List your People HR employees, a page at a time. |
| List everyone's absences | List every employee's absences in one list. |
| List everyone's holidays | List every employee's holiday bookings in one list. |
| Mark an employee as a leaver | Record that an employee is leaving, and when. |
| Record an absence | Record an absence, such as sickness, for an employee. |
| Run a saved query | Run a query saved in People HR's Query Builder and return its rows. |
| Set holiday entitlement | Set an employee's holiday entitlement for this holiday year. |
| Update an employee | Change an employee's details. |
Add a late record
Record that an employee was late on a day. People HR keeps one late record per employee per day.
Inputs
- Employee
employee_idtextRequired - The employee, by the Employee ID on their People HR profile.
- Date
late_datedateRequired - The day they were late. It must be after their start date.
- Minutes late
minutes_latenumberRequired - How late they were, in minutes.At least 1.
- Comments
commentstext - A note on the record, such as the reason.
Outputs
employee_idtext- The Employee ID the step was given.
late_datetext- The day recorded, as yyyy-MM-dd.
messagetext- People HR's confirmation, in its own words.
minutes_latenumber- How many minutes late was recorded.
Example output
{
"employee_id": "E042",
"late_date": "2026-03-03",
"message": "Late record added successfully.",
"minutes_late": 15
}Book a holiday
Book holiday for an employee. People HR checks the duration against its own count of their working days.
Inputs
- Employee
employee_idtextRequired - The employee, by the Employee ID on their People HR profile.
- Start date
start_datedateRequired - First day off.
- End date
end_datedate - Last day off. Leave empty for a single day.
- Length
duration_typetext - A day or more, or part of one day.One of:
1(A day or more),2(Less than a day). Default:1. - Duration in days
duration_daysnumber - For a day or more: the working days it covers.At least 0.
- Duration in minutes
duration_minutesnumber - The minutes off, such as 240 for part of a day. Also needed for a day or more: the minutes those days add up to, such as 450 for one day.At least 1.
- Part of day
part_of_daytext - For less than a day: morning or afternoon.One of:
AM(Morning (AM)),PM(Afternoon (PM)). - Comments
commentstext - A note for the approver.
Outputs
employee_idtext- The Employee ID the step was given.
end_datetext- The last day booked, as yyyy-MM-dd.
holiday_idnumber- The new booking's id in People HR.
messagetext- People HR's confirmation, in its own words.
start_datetext- The first day booked, as yyyy-MM-dd.
Example output
{
"employee_id": "E042",
"end_date": "2026-08-07",
"holiday_id": 9001,
"message": "Holiday added successfully.",
"start_date": "2026-08-03"
}Create an employee
Add an employee to People HR. Job role, location, department, company and employment type values that aren't in People HR's lists yet are added to them.
Inputs
- Employee ID
employee_idtextRequired - The new employee's ID, up to 15 characters, such as E123. It must not be in use.
- First name
first_nametextRequired - First name.
- Last name
last_nametextRequired - Last name.
- Start date
start_datedateRequired - Their first day.
- Job role
job_roletextRequired - Their job title.
- Location
locationtextRequired - Where they work.
- Department
departmenttextRequired - Their department.
- Job role from
job_role_effective_datedate - When the job role applies from. Leave empty to use the start date.
- Company
companytext - The company they're employed by.
- Employment type
employment_typetext - Such as Full Time or Part Time.
- Reports to
reports_totext - Their manager's email address in People HR.
- Title
titletext - A title from People HR's list, such as Mr or Dr. A new one is added to the list.
- Work email
emailtext - The employee's work email address.
- Gender
gendertext - As People HR's list words it.
- Date of birth
date_of_birthdate - The employee's date of birth.
- Nationality
nationalitytext - A nationality from People HR's list.
- Personal email
personal_emailtext - The employee's own email address.
- Personal phone number
personal_phone_numbertext - With + and the country code, such as +447700900123.
- Address
addresstext - The employee's home address.
Outputs
createdtrue/false- True once People HR has confirmed the new employee.
employee_idtext- The new employee's Employee ID.
messagetext- People HR's confirmation, in its own words.
Example output
{
"created": true,
"employee_id": "E042",
"message": "Employee record inserted successfully."
}Delete a holiday
Delete an employee's holiday booking. People HR finds it by its dates, which must match the booking exactly.
Inputs
- Employee
employee_idtextRequired - The employee, by the Employee ID on their People HR profile.
- Start date
start_datedateRequired - The booking's first day.
- End date
end_datedate - The booking's last day. Leave empty for a single day.
Outputs
deletedtrue/false- True once People HR has confirmed the deletion.
employee_idtext- The Employee ID the step was given.
end_datetext- The last day of the deleted booking.
messagetext- People HR's confirmation, in its own words.
start_datetext- The first day of the deleted booking.
Example output
{
"deleted": true,
"employee_id": "E042",
"end_date": "2026-08-07",
"message": "Holiday detail deleted successfully.",
"start_date": "2026-08-03"
}Delete a late record
Delete an employee's late record for one day.
Inputs
- Employee
employee_idtextRequired - The employee, by the Employee ID on their People HR profile.
- Date
late_datedateRequired - The day of the late record to delete.
Outputs
deletedtrue/false- True once People HR has confirmed the deletion.
employee_idtext- The Employee ID the step was given.
late_datetext- The day whose late record was deleted.
messagetext- People HR's confirmation, in its own words.
Example output
{
"deleted": true,
"employee_id": "E042",
"late_date": "2026-03-03",
"message": "Late detail deleted successfully."
}Delete an absence
Delete an employee's absence. People HR finds it by its dates, which must match the absence exactly.
Inputs
- Employee
employee_idtextRequired - The employee, by the Employee ID on their People HR profile.
- Start date
start_datedateRequired - The absence's first day.
- End date
end_datedate - The absence's last day. Leave empty for a single day.
Outputs
deletedtrue/false- True once People HR has confirmed the deletion.
employee_idtext- The Employee ID the step was given.
end_datetext- The last day of the deleted absence.
messagetext- People HR's confirmation, in its own words.
start_datetext- The first day of the deleted absence.
Example output
{
"deleted": true,
"employee_id": "E042",
"end_date": "2026-03-02",
"message": "Absence detail deleted successfully.",
"start_date": "2026-03-02"
}Get an employee
Read one employee's People HR record.
Inputs
- Employee
employee_idtextRequired - The employee, by the Employee ID on their People HR profile.
Outputs
employeeobject- One employee's People HR record.
employee_idtext- The Employee ID the step was given.
rawobject- The record exactly as People HR sent it, with each field's change history.
Example output
{
"employee": {
"AdditionalreportsTo": [],
"AnalysisCode1LabelText": "",
"AnalysisCode2LabelText": "",
"BackgroundDetail": [],
"BankDetail": {
"AccountName": "",
"AccountNumber": "",
"BankAddress": "",
"BankCode": "",
"BankName": ""
},
"Company": "Example Ltd",
"CompanyEffectiveDate": "2024-01-08",
"ContactDetail": {
"Address": "1 Example Street, London",
"Mobile": "+447700900123",
"PersonalEmail": "",
"PersonalPhoneNumber": "",
"WorkPhoneNumber": "+442079460000"
},
"DateOfBirth": "1990-12-10",
"Department": "Engineering",
"DepartmentEffectiveDate": "2024-01-08",
"EmailId": "ada@example.com",
"EmployeeId": "E042",
"EmployeeImage": "",
"EmployeeStatus": "1",
"EmploymentDetail": {
"ATSID": "",
"BenefitsID": "",
"CRMID": "",
"MethodOfRecruitment": "Referral",
"PayrollCompany": "",
"PayrollID": "PAY-042",
"PerformanceID": "",
"RotaID": "",
"System1ID": "",
"System2ID": "",
"System3ID": "",
"TimeAndAttendanceID": ""
},
"EmploymentType": "Full Time",
"EmploymentTypeEffectiveDate": "2024-01-08",
"FirstName": "Ada",
"Gender": "Female",
"HolidayAllowanceDays": "26.00",
"HolidayAllowanceMins": "11700",
"JobRole": "Software Engineer",
"JobRoleChangeDate": "2024-01-08",
"KnownAs": "Ada",
"LastName": "Lovelace",
"LeavingDate": "",
"Location": "London",
"LocationEffectiveDate": "2024-01-08",
"NISNumber": "",
"Nationality": "British",
"NoticePeriod": "1 month",
"OtherContact": [
{
"Comments": "",
"Mobile": "+447700900456",
"OtheContactAddress": "",
"OtherContactName": "Annabella Byron",
"Relationship": "Mother",
"Telephone": ""
}
],
"OtherName": "",
"ProbationEndDate": "2024-07-08",
"ReasonForLeaving": "",
"ReportsTo": "Charles Babbage",
"ReportsToEffectiveDate": "2024-01-08",
"ReportsToEmailAddress": "charles@example.com",
"ReportsToEmployeeId": "E001",
"RightToWork": [],
"StartDate": "2024-01-08",
"Title": "Ms",
"UniqueKey": "6f1c2d3e-4b5a-4c6d-8e7f-9a0b1c2d3e4f"
},
"employee_id": "E042",
"raw": {
"EmployeeId": {
"DisplayValue": "E042",
"FieldHistory": []
},
"FirstName": {
"DisplayValue": "Ada",
"FieldHistory": []
}
}
}Get holiday entitlement
Read an employee's holiday entitlement for each holiday year, in days or hours as your company measures it.
Inputs
- Employee
employee_idtextRequired - The employee, by the Employee ID on their People HR profile.
- From
start_datedate - Only holiday years on or after this date.
- To
end_datedate - Only holiday years on or before this date.
Outputs
countnumber- How many holiday years were found.
employee_idtext- The Employee ID the step was given.
entitlementslist- The employee's entitlement, a year at a time.
Example output
{
"count": 1,
"employee_id": "E042",
"entitlements": [
{
"EndDate": "2026-12-31",
"Entitlement": "25.00",
"FullName": "Ada Lovelace",
"MeasuredIn": "Days",
"StartDate": "2026-01-01"
}
]
}Get salary
Read an employee's current salary, optionally with history.
Inputs
- Employee
employee_idtextRequired - The employee, by the Employee ID on their People HR profile.
- Include history
include_historytrue/false - Also return earlier salaries.Default:
false.
Outputs
countnumber- How many salary records were found.
employee_idtext- The Employee ID the step was given.
salarieslist- The current salary, then any history asked for.
Example output
{
"count": 1,
"employee_id": "E042",
"salaries": [
{
"ChangeReason": "New starter",
"Comments": "",
"Currency": "GBP",
"Deductions": [],
"EffectiveFrom": "2024-01-08",
"Entitlements": [],
"PaymentFrequency": "Monthly",
"SalaryAmount": "30000.0000",
"SalaryType": "Annual",
"TotalSalaryAmount": "30000.0000"
}
]
}List an employee's absences
List one employee's absences.
Inputs
- Employee
employee_idtextRequired - The employee, by the Employee ID on their People HR profile.
- From
start_datedate - Only absences on or after this date.
- To
end_datedate - Only absences on or before this date.
Outputs
absenceslist- The employee's absences.
countnumber- How many absences were found.
employee_idtext- The Employee ID the step was given.
Example output
{
"absences": [
{
"AbsenceLeaveTxnId": 7001,
"AbsencePaidStatus": 2,
"BackToWorkInterviewDate": "",
"BackToWorkInterviewRequried": false,
"Comments": [],
"DurationDays": "1.00",
"DurationInDaysThisPeriod": "1.00",
"EmergencyLeave": false,
"EndDate": "2026-03-02",
"EndDatePartOfTheDay": "",
"FullName": "Ada Lovelace",
"MedicalCertificateReceivedDate": "",
"MedicalCertificateType": 0,
"PartOfDay": "",
"Reason": "Cold / Flu",
"ReferenceId": "",
"StartDate": "2026-03-02",
"StartDatePartOfTheDay": ""
}
],
"count": 1,
"employee_id": "E042"
}List an employee's holidays
List one employee's holiday bookings.
Inputs
- Employee
employee_idtextRequired - The employee, by the Employee ID on their People HR profile.
- From
start_datedate - Only holidays on or after this date.
- To
end_datedate - Only holidays on or before this date.
Outputs
countnumber- How many bookings were found.
employee_idtext- The Employee ID the step was given.
holidayslist- The employee's holiday bookings.
Example output
{
"count": 1,
"employee_id": "E042",
"holidays": [
{
"AnnualLeaveTxnId": 9001,
"Approver": "Charles Babbage",
"ApproverComments": "",
"DurationInDays": 5,
"DurationInDaysThisPeriod": 5,
"DurationInMinutes": 2250,
"DurationInMinutesThisPeriod": 2250,
"DurationType": 1,
"EndDate": "2026-08-07",
"EndDatePartOfTheDay": "",
"IsToilHoliday": false,
"LastActionDateTime": "2026-06-01 09:30:00",
"PartOfDay": "",
"ReferenceId": "",
"RequesterComments": "Summer holiday",
"StartDate": "2026-08-03",
"StartDatePartOfTheDay": "",
"Status": "Approved"
}
]
}List an employee's late records
List the days one employee was late, and by how much.
Inputs
- Employee
employee_idtextRequired - The employee, by the Employee ID on their People HR profile.
- From
start_datedate - Only late records on or after this date.
- To
end_datedate - Only late records on or before this date.
Outputs
countnumber- How many late records were found.
employee_idtext- The Employee ID the step was given.
late_recordslist- The employee's late records.
Example output
{
"count": 1,
"employee_id": "E042",
"late_records": [
{
"Comments": "Train delayed",
"EmployeeId": "E042",
"LateDate": "2026-03-03",
"LateMinutes": 15
}
]
}List employees
List your People HR employees, a page at a time.
Inputs
- Include leavers
include_leaverstrue/false - Also list people marked as leavers.Default:
false. - Employees per page
limitnumber - How many employees to return in one page.From 1 to 500. Default:
100. - Start at
offsetnumber - How many employees to skip: the 'next_offset' of a previous run of this step fetches the following page.At least 0.
Outputs
countnumber- How many employees are on this page.
employeeslist- This page of employees.
has_moretrue/false- Whether more employees follow this page.
next_offsetnumber- The 'Start at' that fetches the next page. Empty on the last page.
offsetnumber- How many employees were skipped before this page.
totalnumber- How many employees match, across every page.
Example output
{
"count": 1,
"employees": [
{
"AdditionalreportsTo": [],
"AnalysisCode1LabelText": "",
"AnalysisCode2LabelText": "",
"BackgroundDetail": [],
"BankDetail": {
"AccountName": "",
"AccountNumber": "",
"BankAddress": "",
"BankCode": "",
"BankName": ""
},
"Company": "Example Ltd",
"CompanyEffectiveDate": "2024-01-08",
"ContactDetail": {
"Address": "1 Example Street, London",
"Mobile": "+447700900123",
"PersonalEmail": "",
"PersonalPhoneNumber": "",
"WorkPhoneNumber": "+442079460000"
},
"DateOfBirth": "1990-12-10",
"Department": "Engineering",
"DepartmentEffectiveDate": "2024-01-08",
"EmailId": "ada@example.com",
"EmployeeId": "E042",
"EmployeeImage": "",
"EmployeeStatus": "1",
"EmploymentDetail": {
"ATSID": "",
"BenefitsID": "",
"CRMID": "",
"MethodOfRecruitment": "Referral",
"PayrollCompany": "",
"PayrollID": "PAY-042",
"PerformanceID": "",
"RotaID": "",
"System1ID": "",
"System2ID": "",
"System3ID": "",
"TimeAndAttendanceID": ""
},
"EmploymentType": "Full Time",
"EmploymentTypeEffectiveDate": "2024-01-08",
"FirstName": "Ada",
"Gender": "Female",
"HolidayAllowanceDays": "26.00",
"HolidayAllowanceMins": "11700",
"JobRole": "Software Engineer",
"JobRoleChangeDate": "2024-01-08",
"KnownAs": "Ada",
"LastName": "Lovelace",
"LeavingDate": "",
"Location": "London",
"LocationEffectiveDate": "2024-01-08",
"NISNumber": "",
"Nationality": "British",
"NoticePeriod": "1 month",
"OtherContact": [
{
"Comments": "",
"Mobile": "+447700900456",
"OtheContactAddress": "",
"OtherContactName": "Annabella Byron",
"Relationship": "Mother",
"Telephone": ""
}
],
"OtherName": "",
"ProbationEndDate": "2024-07-08",
"ReasonForLeaving": "",
"ReportsTo": "Charles Babbage",
"ReportsToEffectiveDate": "2024-01-08",
"ReportsToEmailAddress": "charles@example.com",
"ReportsToEmployeeId": "E001",
"RightToWork": [],
"StartDate": "2024-01-08",
"Title": "Ms",
"UniqueKey": "6f1c2d3e-4b5a-4c6d-8e7f-9a0b1c2d3e4f"
}
],
"has_more": false,
"next_offset": null,
"offset": 0,
"total": 1
}List everyone's absences
List every employee's absences in one list.
Inputs
- From
start_datedate - Only absences on or after this date.
- To
end_datedate - Only absences on or before this date.
Outputs
absenceslist- Everyone's absences, in one list.
countnumber- How many absences were found.
Example output
{
"absences": [
{
"AbsenceLeaveTxnId": 7001,
"AbsencePaidStatus": 2,
"BackToWorkInterviewDate": "",
"BackToWorkInterviewRequried": false,
"Comments": [],
"DurationDays": "1.00",
"DurationInDaysThisPeriod": "1.00",
"EmergencyLeave": false,
"EndDate": "2026-03-02",
"EndDatePartOfTheDay": "",
"FullName": "Ada Lovelace",
"MedicalCertificateReceivedDate": "",
"MedicalCertificateType": 0,
"PartOfDay": "",
"Reason": "Cold / Flu",
"ReferenceId": "",
"StartDate": "2026-03-02",
"StartDatePartOfTheDay": "",
"UniqueEmployeeId": "6f1c2d3e-4b5a-4c6d-8e7f-9a0b1c2d3e4f",
"employee_id": "E042"
}
],
"count": 1
}List everyone's holidays
List every employee's holiday bookings in one list.
Inputs
- From
start_datedate - Only holidays on or after this date.
- To
end_datedate - Only holidays on or before this date.
Outputs
countnumber- How many bookings were found.
holidayslist- Everyone's holiday bookings, in one list.
Example output
{
"count": 1,
"holidays": [
{
"AnnualLeaveTxnId": 9001,
"Approver": "Charles Babbage",
"ApproverComments": "",
"DurationInDays": 5,
"DurationInDaysThisPeriod": 5,
"DurationInMinutes": 2250,
"DurationInMinutesThisPeriod": 2250,
"DurationType": 1,
"EndDate": "2026-08-07",
"EndDatePartOfTheDay": "",
"IsToilHoliday": false,
"LastActionDateTime": "2026-06-01 09:30:00",
"PartOfDay": "",
"ReferenceId": "",
"RequesterComments": "Summer holiday",
"StartDate": "2026-08-03",
"StartDatePartOfTheDay": "",
"Status": "Approved",
"UniqueEmployeeId": "6f1c2d3e-4b5a-4c6d-8e7f-9a0b1c2d3e4f",
"employee_id": "E042"
}
]
}Mark an employee as a leaver
Record that an employee is leaving, and when.
Inputs
- Employee
employee_idtextRequired - The employee, by the Employee ID on their People HR profile.
- Reason for leaving
reason_for_leavingtextRequired - One of the leaving reasons already set up in People HR, spelt exactly the same, such as Resignation.
- Final employment date
final_employment_datedateRequired - Their last day of employment.
- Comments
additional_commentstextRequired - Notes about their leaving.
- Re-employable
re_employabletextRequired - Whether you'd employ them again.One of:
Yes,No. - Final working date
final_working_datedate - Their last day at work. Leave empty to use the final employment date.
- Mark as leaver now
mark_immediatelytrue/false - Mark them as a leaver straight away rather than on the final employment date.Default:
false. - New manager for their reports
reports_totext - Email address of the person their direct reports move to.
- Supporting comments
supporting_commentstext - Any further notes.
Outputs
employee_idtext- The Employee ID the step was given.
final_employment_datetext- The last day of employment, as yyyy-MM-dd.
final_working_datetext- The last day worked, as yyyy-MM-dd.
marked_as_leavertrue/false- True once People HR has recorded the leaver.
messagetext- People HR's confirmation, in its own words.
Example output
{
"employee_id": "E042",
"final_employment_date": "2026-12-31",
"final_working_date": "2026-12-31",
"marked_as_leaver": true,
"message": "Employee Mark Leaver successfully."
}Record an absence
Record an absence, such as sickness, for an employee. People HR checks the duration against its own count of their working days.
Inputs
- Employee
employee_idtextRequired - The employee, by the Employee ID on their People HR profile.
- Start date
start_datedateRequired - First day absent.
- End date
end_datedate - Last day absent. Leave empty for a single day.
- Reason
reasontextRequired - Why they were absent, as People HR's absence reasons word it.
- Duration in days
durationnumberRequired - The working days it covers, such as 1, 0.5 or 0.25.At least 0.
- Paid status
paid_statustextRequired - Whether the absence is paid.One of:
1(Unpaid),2(Paid),3(Paid at other rate / as normal). - Length
duration_typetext - A day or more, half a day, or a quarter of a day.One of:
1(A day or more),2(Half a day),3(Quarter of a day). Default:1. - Part of day
part_of_daytext - For part of a day: morning or afternoon.One of:
AM(Morning (AM)),PM(Afternoon (PM)). - Emergency leave
emergency_leavetrue/false - Record it as emergency leave.Default:
false. - Comment
commenttext - A note on the absence.
Outputs
absence_idnumber- The new absence's id in People HR.
employee_idtext- The Employee ID the step was given.
end_datetext- The last day of the absence, as yyyy-MM-dd.
messagetext- People HR's confirmation, in its own words.
start_datetext- The first day of the absence, as yyyy-MM-dd.
Example output
{
"absence_id": 7001,
"employee_id": "E042",
"end_date": "2026-03-02",
"message": "Absence added successfully.",
"start_date": "2026-03-02"
}Run a saved query
Run a query saved in People HR's Query Builder and return its rows. The API key needs that query ticked under Settings > API.
Inputs
- Query name
query_nametextRequired - The saved query's name, exactly as written in People HR, including capital letters.
Outputs
columnslist- The query's column headings, in the order they came.
countnumber- How many rows the query returned.
query_nametext- The saved query that was run.
rowslist- The query's rows. Each one is keyed by the query's column headings.
Example output
{
"columns": [
"Employee Id",
"First Name"
],
"count": 1,
"query_name": "Headcount",
"rows": [
{
"Employee Id": "E042",
"First Name": "Ada"
}
]
}Set holiday entitlement
Set an employee's holiday entitlement for this holiday year.
Inputs
- Employee
employee_idtextRequired - The employee, by the Employee ID on their People HR profile.
- Entitlement this year
entitlement_this_yearnumberRequired - In the unit your company measures holiday in (days or hours). 'Get holiday entitlement' shows which.At least 0.
- Reason for change
reason_for_changetextRequired - Why the entitlement changed. People HR keeps it in the history.
Outputs
employee_idtext- The Employee ID the step was given.
entitlement_this_yearnumber- The entitlement set for this year, in the account's unit.
messagetext- People HR's confirmation, in its own words.
updatedtrue/false- True once People HR has confirmed the change.
Example output
{
"employee_id": "E042",
"entitlement_this_year": 25,
"message": "Entitlement This Year updated successfully.",
"updated": true
}Update an employee
Change an employee's details. Only the fields you fill in are changed. A new job role, location, department, company, manager or employment type applies from its 'from' date, or from today when that is empty.
Inputs
- Employee
employee_idtextRequired - The employee, by the Employee ID on their People HR profile.
- Reason for change
reason_for_changetextRequired - Why the details changed. People HR keeps it in the record's history.
- First name
first_nametext - New first name.
- Last name
last_nametext - New last name.
- Start date
start_datedate - New start date.
- Job role
job_roletext - New job role.
- Job role from
job_role_effective_datedate - When it applies.
- Location
locationtext - New location.
- Location from
location_effective_datedate - When it applies.
- Department
departmenttext - New department.
- Department from
department_effective_datedate - When it applies.
- Company
companytext - New company.
- Company from
company_effective_datedate - When it applies.
- Reports to
reports_totext - New manager's email address.
- Reports to from
reports_to_effective_datedate - When it applies.
- Employment type
employment_typetext - New employment type.
- Employment type from
employment_type_effective_datedate - When it applies.
- Title
titletext - A title from People HR's list, such as Mr or Dr. A new one is added to the list.
- Work email
emailtext - The employee's work email address.
- Gender
gendertext - As People HR's list words it.
- Date of birth
date_of_birthdate - The employee's date of birth.
- Nationality
nationalitytext - A nationality from People HR's list.
- Personal email
personal_emailtext - The employee's own email address.
- Personal phone number
personal_phone_numbertext - With + and the country code, such as +447700900123.
- Address
addresstext - The employee's home address.
Outputs
changed_fieldslist- The People HR fields that were changed, by their API names.
employee_idtext- The Employee ID the step was given.
messagetext- People HR's confirmation, in its own words.
updatedtrue/false- True once People HR has confirmed the change.
Example output
{
"changed_fields": [
"FirstName"
],
"employee_id": "E042",
"message": "Employee record updated successfully.",
"updated": true
}