> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# PeopleHR

> How to set up the PeopleHR connector, plus the actions that are available.

![PeopleHR](https://stackone-logos.com/api/peoplehr/filled/svg)

Betav1.1.0[See changelog](https://docs.stackone.com/connectors/peoplehr/changelog.md)

[58 actions](#actions) · 1 auth method

HRIS

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/peoplehr/guides/connector-profile/api-key.md)
>
> PeopleHR uses API key authentication. The API key is passed in the JSON request body of every API call. All endpoints us...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/peoplehr/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

58 actions

ActionDescription

List Employees`peoplehr_list_employees`

Retrieve a list of all employees

Get Employee`peoplehr_get_employee`

Retrieve details for a specific employee by ID. Use list\_employees first to find the EmployeeId.

Create Employee`peoplehr_create_employee`

Create a new employee record

Update Employee`peoplehr_update_employee`

Update an existing employee's details. Requires EmployeeId, ReasonForChange, and all core fields (name, gender, dates, j...

Mark Employee As Leaver`peoplehr_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`peoplehr_update_employee_id`

Change an employee's ID to a new value

Add Employee Image`peoplehr_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`peoplehr_get_absences`

Retrieve unplanned absence records (sick leave, personal leave) for an employee within a date range. Use list\_employees...

Create Absence`peoplehr_create_absence`

Add a new unplanned absence record (sick leave, personal leave) for an employee. DurationType codes: 1=Days, 2=Hours, 3=...

Update Absence`peoplehr_update_absence`

Update an existing absence record. Requires OldStartDate and OldEndDate from the original record — use get\_absences firs...

Delete Absence`peoplehr_delete_absence`

Delete an absence record for an employee. Identified by StartDate and EndDate — use get\_absences first to find the dates...

Get Holidays`peoplehr_get_holidays`

Retrieve planned annual leave / vacation booking records for an employee, optionally filtered by date range. Use list\_em...

Create Holiday`peoplehr_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`peoplehr_update_holiday`

Update an existing planned leave booking for an employee. Requires OldStartDate and OldEndDate from the original booking...

Delete Holiday`peoplehr_delete_holiday`

Delete a holiday booking for an employee. Identified by StartDate and EndDate of the booking — use get\_holidays first to...

Get Salary`peoplehr_get_salary`

Retrieve salary details for an employee, with optional history. Use list\_employees to find the EmployeeId first.

Create Salary`peoplehr_create_salary`

Create a new salary record for an employee. Use list\_employees to find the EmployeeId first. Deductions and Entitlements...

Delete Salary`peoplehr_delete_salary`

Delete a salary record for an employee. Identified by EffectiveFrom date — use get\_salary first to find it.

List Documents`peoplehr_list_documents`

Retrieve all documents for an employee. Use list\_employees to find the EmployeeId first.

Get Document`peoplehr_get_document`

Retrieve a specific employee document by DocumentId. Use list\_documents first to find the DocumentId.

Upload Document`peoplehr_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`peoplehr_get_timesheets`

Retrieve timesheet records for an employee. Use list\_employees to find the EmployeeId first.

Create Timesheet`peoplehr_create_timesheet`

Create a new timesheet entry for an employee

Update Timesheet`peoplehr_update_timesheet`

Update an existing timesheet entry for an employee

Delete Timesheet`peoplehr_delete_timesheet`

Delete a timesheet entry for an employee. Identified by TimesheetDate — use get\_timesheets first to find the date.

Get Appraisals By Employee`peoplehr_get_appraisals_by_employee`

Retrieve all appraisal / performance review records for an employee. Use list\_employees to find the EmployeeId first.

Get Appraisal`peoplehr_get_appraisal`

Retrieve a specific appraisal record by AppraisalId. Use get\_appraisals\_by\_employee first to find the AppraisalId.

Create Appraisal`peoplehr_create_appraisal`

Create a new appraisal record for an employee

Update Appraisal`peoplehr_update_appraisal`

Update an existing appraisal record

Delete Appraisal`peoplehr_delete_appraisal`

Delete an appraisal record. Requires AppraisalId — use get\_appraisals\_by\_employee first to find it.

Get Benefits By Employee`peoplehr_get_benefits_by_employee`

Retrieve all benefit records for a specific employee. Use list\_employees to find the EmployeeId first.

Get Benefit`peoplehr_get_benefit`

Retrieve a specific benefit record by its BenefitId. Use get\_benefits\_by\_employee first to find the BenefitId.

Create Benefit`peoplehr_create_benefit`

Add a new benefit record for an employee

Update Benefit`peoplehr_update_benefit`

Update an existing benefit record for an employee

Delete Benefit`peoplehr_delete_benefit`

Delete a benefit record for an employee. Requires BenefitId — use get\_benefits\_by\_employee first to find it.

Get Qualifications By Employee`peoplehr_get_qualifications_by_employee`

Retrieve all qualification records for a specific employee. Use list\_employees to find the EmployeeId first.

Get Qualification`peoplehr_get_qualification`

Retrieve a specific qualification record by QualificationId. Use get\_qualifications\_by\_employee first to find the Qualif...

Create Qualification`peoplehr_create_qualification`

Add a new qualification record for an employee

Update Qualification`peoplehr_update_qualification`

Update an existing qualification record for an employee

Delete Qualification`peoplehr_delete_qualification`

Delete a qualification record for an employee. Requires QualificationId — use get\_qualifications\_by\_employee first to fi...

Get Trainings`peoplehr_get_trainings`

Retrieve all training records for a specific employee. Use list\_employees to find the EmployeeId first.

Create Training`peoplehr_create_training`

Add a new training record for an employee

Update Training`peoplehr_update_training`

Update an existing training record for an employee

Delete Training`peoplehr_delete_training`

Delete a training record for an employee. Requires TrainingId — use get\_trainings first to find it.

Get Holiday Entitlement`peoplehr_get_holiday_entitlement`

Retrieve current year holiday entitlement (remaining allowance) for a specific employee. Use list\_employees to find the...

Update Holiday Entitlement`peoplehr_update_holiday_entitlement`

Update the current year holiday entitlement for a specific employee. Requires EntitlementThisYear value and ReasonForCha...

Get Next Year Holiday Entitlement`peoplehr_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`peoplehr_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`peoplehr_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`peoplehr_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`peoplehr_get_maternity_paternity`

Retrieve a specific maternity/paternity record by MaternityPaternityTxnId. Use get\_maternity\_paternity\_by\_employee first...

Create Maternity/Paternity`peoplehr_create_maternity_paternity`

Add a new maternity/paternity record for an employee

Update Maternity/Paternity`peoplehr_update_maternity_paternity`

Update an existing maternity/paternity record for an employee

Delete Maternity/Paternity`peoplehr_delete_maternity_paternity`

Delete a maternity/paternity record. Requires MaternityPaternityTxnId — use get\_maternity\_paternity\_by\_employee first to...

Get Right To Work`peoplehr_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`peoplehr_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`peoplehr_update_right_to_work`

Update an existing right to work record for an employee

Delete Right To Work`peoplehr_delete_right_to_work`

Delete a right to work record. Requires RightToWorkTxnId — use get\_right\_to\_work first to find it.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.