Skip to main content
PeopleHR
PeopleHR
58 actions · 1 auth method
BetaHRIS

​
Authentication

API Key

PeopleHR uses API key authentication. The API key is passed in the JSON request body of every API call. All endpoints us…Guides: Connector Profile, Link Account
Actions
58 actions
Action
Description
List Employees
Retrieve a list of all employees
Get Employee
Retrieve details for a specific employee by ID. Use list_employees first to find the EmployeeId.
Create Employee
Create a new employee record
Update Employee
Update an existing employee’s details. Requires EmployeeId, ReasonForChange, and all core fields (name, gender, dates, j…
Mark Employee As Leaver
Mark an employee as a leaver with a leaving date and reason. Use list_employees to find the EmployeeId first.
Update Employee ID
Change an employee’s ID to a new value
Add Employee Image
Upload a profile image for an employee. Requires EmployeeId, image filename (e.g. photo.png), and base64-encoded image d…
Get Absences
Retrieve unplanned absence records (sick leave, personal leave) for an employee within a date range. Use list_employees…
Create Absence
Add a new unplanned absence record (sick leave, personal leave) for an employee. DurationType codes: 1=Days, 2=Hours, 3=…
Update Absence
Update an existing absence record. Requires OldStartDate and OldEndDate from the original record — use get_absences firs…
Delete Absence
Delete an absence record for an employee. Identified by StartDate and EndDate — use get_absences first to find the dates…
Get Holidays
Retrieve planned annual leave / vacation booking records for an employee, optionally filtered by date range. Use list_em…
Create Holiday
Book a new planned annual leave / vacation for an employee. DurationType codes: 1=Days, 2=Hours, 3=Half Day. Use list_em…
Update Holiday
Update an existing planned leave booking for an employee. Requires OldStartDate and OldEndDate from the original booking…
Delete Holiday
Delete a holiday booking for an employee. Identified by StartDate and EndDate of the booking — use get_holidays first to…
Get Salary
Retrieve salary details for an employee, with optional history. Use list_employees to find the EmployeeId first.
Create Salary
Create a new salary record for an employee. Use list_employees to find the EmployeeId first. Deductions and Entitlements…
Delete Salary
Delete a salary record for an employee. Identified by EffectiveFrom date — use get_salary first to find it.
List Documents
Retrieve all documents for an employee. Use list_employees to find the EmployeeId first.
Get Document
Retrieve a specific employee document by DocumentId. Use list_documents first to find the DocumentId.
Upload Document
Upload a document to an employee’s record. Requires base64-encoded file content in the File field and a Category (e.g. ”…
Get Timesheets
Retrieve timesheet records for an employee. Use list_employees to find the EmployeeId first.
Create Timesheet
Create a new timesheet entry for an employee
Update Timesheet
Update an existing timesheet entry for an employee
Delete Timesheet
Delete a timesheet entry for an employee. Identified by TimesheetDate — use get_timesheets first to find the date.
Get Appraisals By Employee
Retrieve all appraisal / performance review records for an employee. Use list_employees to find the EmployeeId first.
Get Appraisal
Retrieve a specific appraisal record by AppraisalId. Use get_appraisals_by_employee first to find the AppraisalId.
Create Appraisal
Create a new appraisal record for an employee
Update Appraisal
Update an existing appraisal record
Delete Appraisal
Delete an appraisal record. Requires AppraisalId — use get_appraisals_by_employee first to find it.
Get Benefits By Employee
Retrieve all benefit records for a specific employee. Use list_employees to find the EmployeeId first.
Get Benefit
Retrieve a specific benefit record by its BenefitId. Use get_benefits_by_employee first to find the BenefitId.
Create Benefit
Add a new benefit record for an employee
Update Benefit
Update an existing benefit record for an employee
Delete Benefit
Delete a benefit record for an employee. Requires BenefitId — use get_benefits_by_employee first to find it.
Get Qualifications By Employee
Retrieve all qualification records for a specific employee. Use list_employees to find the EmployeeId first.
Get Qualification
Retrieve a specific qualification record by QualificationId. Use get_qualifications_by_employee first to find the Qualif…
Create Qualification
Add a new qualification record for an employee
Update Qualification
Update an existing qualification record for an employee
Delete Qualification
Delete a qualification record for an employee. Requires QualificationId — use get_qualifications_by_employee first to fi…
Get Trainings
Retrieve all training records for a specific employee. Use list_employees to find the EmployeeId first.
Create Training
Add a new training record for an employee
Update Training
Update an existing training record for an employee
Delete Training
Delete a training record for an employee. Requires TrainingId — use get_trainings first to find it.
Get Holiday Entitlement
Retrieve current year holiday entitlement (remaining allowance) for a specific employee. Use list_employees to find the…
Update Holiday Entitlement
Update the current year holiday entitlement for a specific employee. Requires EntitlementThisYear value and ReasonForCha…
Get Next Year Holiday Entitlement
Retrieve next year’s holiday entitlement (future year allowance) for a specific employee. For current year, use get_holi…
Update Next Year Holiday Entitlement
Update next year’s holiday entitlement for a specific employee. For current year, use update_holiday_entitlement instead…
Get Work Pattern
Retrieve details of a specific work pattern by WorkPatternId. The WorkPatternId can be found in the employee detail resp…
Get Maternity/Paternity By Employee
Retrieve all maternity/paternity leave records for a specific employee. Use list_employees to find the EmployeeId first.
Get Maternity/Paternity
Retrieve a specific maternity/paternity record by MaternityPaternityTxnId. Use get_maternity_paternity_by_employee first…
Create Maternity/Paternity
Add a new maternity/paternity record for an employee
Update Maternity/Paternity
Update an existing maternity/paternity record for an employee
Delete Maternity/Paternity
Delete a maternity/paternity record. Requires MaternityPaternityTxnId — use get_maternity_paternity_by_employee first to…
Get Right To Work
Retrieve right to work / visa / work permit details for a specific employee. Use list_employees to find the EmployeeId f…
Create Right To Work
Add a new right to work / visa / work permit record for an employee. DocumentId here means the document reference number…
Update Right To Work
Update an existing right to work record for an employee
Delete Right To Work
Delete a right to work record. Requires RightToWorkTxnId — use get_right_to_work first to find it.

​
Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See the Projects Guide.
2

Configure the Connector

Enable the connector and set up a connector profile in your project. See Managing Connectors.
https://stackone-logos.com/api/peoplehr/filled/png

Connector Profile

PeopleHR - API Key
3

Link an Account

Connect an account using StackOne Hub or Auth Link.
https://stackone-logos.com/api/peoplehr/filled/png

Link Account

PeopleHR - API Key
4

Use Actions

Invoke actions using one of the methods below: