> ## 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.

<div className="connector-page-header">
  <img src="https://stackone-logos.com/api/peoplehr/filled/svg" alt="PeopleHR" className="connector-page-icon" />

  <div className="connector-page-changelog">
    <div className="connector-page-version"><span className="connector-page-tag-beta connector-page-stage-tag">Beta</span><span>v1.1.0</span></div>
    <div><a href="/connectors/peoplehr/changelog">See changelog</a></div>
  </div>

  <div className="connector-page-header-meta">
    <div className="connector-page-subtitle"><a href="#actions">58 actions</a> · 1 auth method</div>

    <div className="connector-page-category-tags">
      <span className="connector-page-category-tag">HRIS</span>
    </div>
  </div>
</div>

## Getting Started

<Steps>
  <Step title="Create or Select a Project">
    Set up a new project or select an existing one. See [Organizations & Projects](/gateway/concepts/organizations-and-projects).
  </Step>

  <Step title="Configure the Connector">
    Enable the connector and set up a Connector Profile in your project. See [Setup Connector Profile](/gateway/quickstart#setup-connector-profile).

    <Columns cols={2}>
      <Card title="Connector Profile · API Key" href="/connectors/peoplehr/guides/connector-profile/api-key" icon="https://stackone-logos.com/api/peoplehr/filled/svg" horizontal>
        PeopleHR uses API key authentication. The API key is passed in the JSON request body of every API call. All endpoints us...
      </Card>
    </Columns>
  </Step>

  <Step title="Link an Account">
    Link an account [from the dashboard](/connect/managing-connectors/linking-accounts#link-from-the-dashboard) (or via [StackOne Hub](/embed/account-linking/overview)).

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

    <Columns cols={2}>
      <Card title="Link Account · API Key" href="/connectors/peoplehr/guides/link-account/api-key" icon="https://stackone-logos.com/api/peoplehr/filled/svg" horizontal />
    </Columns>
  </Step>

  <Step title="Use Actions">
    Connect an AI platform to the linked account's actions. See [AI Platforms](/connect/ai-platforms/overview).

    Other ways to call actions are listed in [Protocols & SDKs](/connect/protocols-and-sdks).
  </Step>
</Steps>

## Actions

<div className="connector-meta-library-section">
  <div className="connector-actions-controls not-prose" data-connector-actions-controls>
    <div className="connector-actions-controls__row">
      <input type="search" className="connector-actions-search" data-connector-actions-search placeholder="Search actions" aria-label="Search actions" />
    </div>
  </div>

  <div className="meta-library-count" data-connector-actions-count>58 actions</div>

  <div className="not-prose meta-library-table-container" data-connector-actions-table>
    <div className="connector-meta-library-grid">
      <div className="connector-meta-library-row">
        <div className="meta-library-grid-header-cell">Action</div>
        <div className="meta-library-grid-header-cell">Description</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_list_employees" data-action-label="List Employees" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Employees</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_list_employees" aria-label="Copy peoplehr_list_employees"><code className="connector-page-code">peoplehr\_list\_employees</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve a list of all employees</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_get_employee" data-action-label="Get Employee" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Employee</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_get_employee" aria-label="Copy peoplehr_get_employee"><code className="connector-page-code">peoplehr\_get\_employee</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve details for a specific employee by ID. Use list\_employees first to find the EmployeeId.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_create_employee" data-action-label="Create Employee" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Create Employee</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_create_employee" aria-label="Copy peoplehr_create_employee"><code className="connector-page-code">peoplehr\_create\_employee</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Create a new employee record</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_update_employee" data-action-label="Update Employee" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Update Employee</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_update_employee" aria-label="Copy peoplehr_update_employee"><code className="connector-page-code">peoplehr\_update\_employee</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Update an existing employee's details. Requires EmployeeId, ReasonForChange, and all core fields (name, gender, dates, j...</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_mark_employee_as_leaver" data-action-label="Mark Employee As Leaver" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Mark Employee As Leaver</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_mark_employee_as_leaver" aria-label="Copy peoplehr_mark_employee_as_leaver"><code className="connector-page-code">peoplehr\_mark\_employee\_as\_leaver</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Mark an employee as a leaver with a leaving date and reason. Use list\_employees to find the EmployeeId first.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_update_employee_id" data-action-label="Update Employee ID" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Update Employee ID</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_update_employee_id" aria-label="Copy peoplehr_update_employee_id"><code className="connector-page-code">peoplehr\_update\_employee\_id</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Change an employee's ID to a new value</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_add_employee_image" data-action-label="Add Employee Image" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Add Employee Image</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_add_employee_image" aria-label="Copy peoplehr_add_employee_image"><code className="connector-page-code">peoplehr\_add\_employee\_image</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Upload a profile image for an employee. Requires EmployeeId, image filename (e.g. photo.png), and base64-encoded image d...</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_get_absences" data-action-label="Get Absences" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Absences</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_get_absences" aria-label="Copy peoplehr_get_absences"><code className="connector-page-code">peoplehr\_get\_absences</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve unplanned absence records (sick leave, personal leave) for an employee within a date range. Use list\_employees...</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_create_absence" data-action-label="Create Absence" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Create Absence</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_create_absence" aria-label="Copy peoplehr_create_absence"><code className="connector-page-code">peoplehr\_create\_absence</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Add a new unplanned absence record (sick leave, personal leave) for an employee. DurationType codes: 1=Days, 2=Hours, 3=...</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_update_absence" data-action-label="Update Absence" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Update Absence</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_update_absence" aria-label="Copy peoplehr_update_absence"><code className="connector-page-code">peoplehr\_update\_absence</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Update an existing absence record. Requires OldStartDate and OldEndDate from the original record — use get\_absences firs...</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_delete_absence" data-action-label="Delete Absence" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Delete Absence</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_delete_absence" aria-label="Copy peoplehr_delete_absence"><code className="connector-page-code">peoplehr\_delete\_absence</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Delete an absence record for an employee. Identified by StartDate and EndDate — use get\_absences first to find the dates...</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_get_holidays" data-action-label="Get Holidays" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Holidays</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_get_holidays" aria-label="Copy peoplehr_get_holidays"><code className="connector-page-code">peoplehr\_get\_holidays</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve planned annual leave / vacation booking records for an employee, optionally filtered by date range. Use list\_em...</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_create_holiday" data-action-label="Create Holiday" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Create Holiday</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_create_holiday" aria-label="Copy peoplehr_create_holiday"><code className="connector-page-code">peoplehr\_create\_holiday</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Book a new planned annual leave / vacation for an employee. DurationType codes: 1=Days, 2=Hours, 3=Half Day. Use list\_em...</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_update_holiday" data-action-label="Update Holiday" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Update Holiday</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_update_holiday" aria-label="Copy peoplehr_update_holiday"><code className="connector-page-code">peoplehr\_update\_holiday</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Update an existing planned leave booking for an employee. Requires OldStartDate and OldEndDate from the original booking...</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_delete_holiday" data-action-label="Delete Holiday" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Delete Holiday</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_delete_holiday" aria-label="Copy peoplehr_delete_holiday"><code className="connector-page-code">peoplehr\_delete\_holiday</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Delete a holiday booking for an employee. Identified by StartDate and EndDate of the booking — use get\_holidays first to...</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_get_salary" data-action-label="Get Salary" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Salary</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_get_salary" aria-label="Copy peoplehr_get_salary"><code className="connector-page-code">peoplehr\_get\_salary</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve salary details for an employee, with optional history. Use list\_employees to find the EmployeeId first.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_create_salary" data-action-label="Create Salary" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Create Salary</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_create_salary" aria-label="Copy peoplehr_create_salary"><code className="connector-page-code">peoplehr\_create\_salary</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Create a new salary record for an employee. Use list\_employees to find the EmployeeId first. Deductions and Entitlements...</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_delete_salary" data-action-label="Delete Salary" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Delete Salary</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_delete_salary" aria-label="Copy peoplehr_delete_salary"><code className="connector-page-code">peoplehr\_delete\_salary</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Delete a salary record for an employee. Identified by EffectiveFrom date — use get\_salary first to find it.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_list_documents" data-action-label="List Documents" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Documents</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_list_documents" aria-label="Copy peoplehr_list_documents"><code className="connector-page-code">peoplehr\_list\_documents</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve all documents for an employee. Use list\_employees to find the EmployeeId first.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_get_document" data-action-label="Get Document" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Document</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_get_document" aria-label="Copy peoplehr_get_document"><code className="connector-page-code">peoplehr\_get\_document</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve a specific employee document by DocumentId. Use list\_documents first to find the DocumentId.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_upload_document" data-action-label="Upload Document" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Upload Document</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_upload_document" aria-label="Copy peoplehr_upload_document"><code className="connector-page-code">peoplehr\_upload\_document</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Upload a document to an employee's record. Requires base64-encoded file content in the File field and a Category (e.g. "...</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_get_timesheets" data-action-label="Get Timesheets" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Timesheets</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_get_timesheets" aria-label="Copy peoplehr_get_timesheets"><code className="connector-page-code">peoplehr\_get\_timesheets</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve timesheet records for an employee. Use list\_employees to find the EmployeeId first.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_create_timesheet" data-action-label="Create Timesheet" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Create Timesheet</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_create_timesheet" aria-label="Copy peoplehr_create_timesheet"><code className="connector-page-code">peoplehr\_create\_timesheet</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Create a new timesheet entry for an employee</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_update_timesheet" data-action-label="Update Timesheet" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Update Timesheet</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_update_timesheet" aria-label="Copy peoplehr_update_timesheet"><code className="connector-page-code">peoplehr\_update\_timesheet</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Update an existing timesheet entry for an employee</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_delete_timesheet" data-action-label="Delete Timesheet" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Delete Timesheet</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_delete_timesheet" aria-label="Copy peoplehr_delete_timesheet"><code className="connector-page-code">peoplehr\_delete\_timesheet</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Delete a timesheet entry for an employee. Identified by TimesheetDate — use get\_timesheets first to find the date.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_get_appraisals_by_employee" data-action-label="Get Appraisals By Employee" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Appraisals By Employee</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_get_appraisals_by_employee" aria-label="Copy peoplehr_get_appraisals_by_employee"><code className="connector-page-code">peoplehr\_get\_appraisals\_by\_employee</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve all appraisal / performance review records for an employee. Use list\_employees to find the EmployeeId first.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_get_appraisal" data-action-label="Get Appraisal" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Appraisal</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_get_appraisal" aria-label="Copy peoplehr_get_appraisal"><code className="connector-page-code">peoplehr\_get\_appraisal</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve a specific appraisal record by AppraisalId. Use get\_appraisals\_by\_employee first to find the AppraisalId.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_create_appraisal" data-action-label="Create Appraisal" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Create Appraisal</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_create_appraisal" aria-label="Copy peoplehr_create_appraisal"><code className="connector-page-code">peoplehr\_create\_appraisal</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Create a new appraisal record for an employee</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_update_appraisal" data-action-label="Update Appraisal" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Update Appraisal</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_update_appraisal" aria-label="Copy peoplehr_update_appraisal"><code className="connector-page-code">peoplehr\_update\_appraisal</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Update an existing appraisal record</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_delete_appraisal" data-action-label="Delete Appraisal" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Delete Appraisal</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_delete_appraisal" aria-label="Copy peoplehr_delete_appraisal"><code className="connector-page-code">peoplehr\_delete\_appraisal</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Delete an appraisal record. Requires AppraisalId — use get\_appraisals\_by\_employee first to find it.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_get_benefits_by_employee" data-action-label="Get Benefits By Employee" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Benefits By Employee</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_get_benefits_by_employee" aria-label="Copy peoplehr_get_benefits_by_employee"><code className="connector-page-code">peoplehr\_get\_benefits\_by\_employee</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve all benefit records for a specific employee. Use list\_employees to find the EmployeeId first.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_get_benefit" data-action-label="Get Benefit" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Benefit</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_get_benefit" aria-label="Copy peoplehr_get_benefit"><code className="connector-page-code">peoplehr\_get\_benefit</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve a specific benefit record by its BenefitId. Use get\_benefits\_by\_employee first to find the BenefitId.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_create_benefit" data-action-label="Create Benefit" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Create Benefit</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_create_benefit" aria-label="Copy peoplehr_create_benefit"><code className="connector-page-code">peoplehr\_create\_benefit</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Add a new benefit record for an employee</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_update_benefit" data-action-label="Update Benefit" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Update Benefit</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_update_benefit" aria-label="Copy peoplehr_update_benefit"><code className="connector-page-code">peoplehr\_update\_benefit</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Update an existing benefit record for an employee</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_delete_benefit" data-action-label="Delete Benefit" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Delete Benefit</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_delete_benefit" aria-label="Copy peoplehr_delete_benefit"><code className="connector-page-code">peoplehr\_delete\_benefit</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Delete a benefit record for an employee. Requires BenefitId — use get\_benefits\_by\_employee first to find it.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_get_qualifications_by_employee" data-action-label="Get Qualifications By Employee" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Qualifications By Employee</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_get_qualifications_by_employee" aria-label="Copy peoplehr_get_qualifications_by_employee"><code className="connector-page-code">peoplehr\_get\_qualifications\_by\_employee</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve all qualification records for a specific employee. Use list\_employees to find the EmployeeId first.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_get_qualification" data-action-label="Get Qualification" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Qualification</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_get_qualification" aria-label="Copy peoplehr_get_qualification"><code className="connector-page-code">peoplehr\_get\_qualification</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve a specific qualification record by QualificationId. Use get\_qualifications\_by\_employee first to find the Qualif...</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_create_qualification" data-action-label="Create Qualification" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Create Qualification</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_create_qualification" aria-label="Copy peoplehr_create_qualification"><code className="connector-page-code">peoplehr\_create\_qualification</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Add a new qualification record for an employee</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_update_qualification" data-action-label="Update Qualification" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Update Qualification</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_update_qualification" aria-label="Copy peoplehr_update_qualification"><code className="connector-page-code">peoplehr\_update\_qualification</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Update an existing qualification record for an employee</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_delete_qualification" data-action-label="Delete Qualification" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Delete Qualification</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_delete_qualification" aria-label="Copy peoplehr_delete_qualification"><code className="connector-page-code">peoplehr\_delete\_qualification</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Delete a qualification record for an employee. Requires QualificationId — use get\_qualifications\_by\_employee first to fi...</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_get_trainings" data-action-label="Get Trainings" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Trainings</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_get_trainings" aria-label="Copy peoplehr_get_trainings"><code className="connector-page-code">peoplehr\_get\_trainings</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve all training records for a specific employee. Use list\_employees to find the EmployeeId first.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_create_training" data-action-label="Create Training" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Create Training</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_create_training" aria-label="Copy peoplehr_create_training"><code className="connector-page-code">peoplehr\_create\_training</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Add a new training record for an employee</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_update_training" data-action-label="Update Training" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Update Training</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_update_training" aria-label="Copy peoplehr_update_training"><code className="connector-page-code">peoplehr\_update\_training</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Update an existing training record for an employee</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_delete_training" data-action-label="Delete Training" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Delete Training</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_delete_training" aria-label="Copy peoplehr_delete_training"><code className="connector-page-code">peoplehr\_delete\_training</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Delete a training record for an employee. Requires TrainingId — use get\_trainings first to find it.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_get_holiday_entitlement" data-action-label="Get Holiday Entitlement" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Holiday Entitlement</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_get_holiday_entitlement" aria-label="Copy peoplehr_get_holiday_entitlement"><code className="connector-page-code">peoplehr\_get\_holiday\_entitlement</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve current year holiday entitlement (remaining allowance) for a specific employee. Use list\_employees to find the...</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_update_holiday_entitlement" data-action-label="Update Holiday Entitlement" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Update Holiday Entitlement</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_update_holiday_entitlement" aria-label="Copy peoplehr_update_holiday_entitlement"><code className="connector-page-code">peoplehr\_update\_holiday\_entitlement</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Update the current year holiday entitlement for a specific employee. Requires EntitlementThisYear value and ReasonForCha...</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_get_next_year_holiday_entitlement" data-action-label="Get Next Year Holiday Entitlement" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Next Year Holiday Entitlement</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_get_next_year_holiday_entitlement" aria-label="Copy peoplehr_get_next_year_holiday_entitlement"><code className="connector-page-code">peoplehr\_get\_next\_year\_holiday\_entitlement</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve next year's holiday entitlement (future year allowance) for a specific employee. For current year, use get\_holi...</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_update_next_year_holiday_entitlement" data-action-label="Update Next Year Holiday Entitlement" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Update Next Year Holiday Entitlement</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_update_next_year_holiday_entitlement" aria-label="Copy peoplehr_update_next_year_holiday_entitlement"><code className="connector-page-code">peoplehr\_update\_next\_year\_holiday\_entitlement</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Update next year's holiday entitlement for a specific employee. For current year, use update\_holiday\_entitlement instead...</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_get_work_pattern" data-action-label="Get Work Pattern" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Work Pattern</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_get_work_pattern" aria-label="Copy peoplehr_get_work_pattern"><code className="connector-page-code">peoplehr\_get\_work\_pattern</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve details of a specific work pattern by WorkPatternId. The WorkPatternId can be found in the employee detail resp...</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_get_maternity_paternity_by_employee" data-action-label="Get Maternity/Paternity By Employee" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Maternity/Paternity By Employee</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_get_maternity_paternity_by_employee" aria-label="Copy peoplehr_get_maternity_paternity_by_employee"><code className="connector-page-code">peoplehr\_get\_maternity\_paternity\_by\_employee</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve all maternity/paternity leave records for a specific employee. Use list\_employees to find the EmployeeId first.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_get_maternity_paternity" data-action-label="Get Maternity/Paternity" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Maternity/Paternity</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_get_maternity_paternity" aria-label="Copy peoplehr_get_maternity_paternity"><code className="connector-page-code">peoplehr\_get\_maternity\_paternity</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve a specific maternity/paternity record by MaternityPaternityTxnId. Use get\_maternity\_paternity\_by\_employee first...</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_create_maternity_paternity" data-action-label="Create Maternity/Paternity" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Create Maternity/Paternity</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_create_maternity_paternity" aria-label="Copy peoplehr_create_maternity_paternity"><code className="connector-page-code">peoplehr\_create\_maternity\_paternity</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Add a new maternity/paternity record for an employee</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_update_maternity_paternity" data-action-label="Update Maternity/Paternity" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Update Maternity/Paternity</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_update_maternity_paternity" aria-label="Copy peoplehr_update_maternity_paternity"><code className="connector-page-code">peoplehr\_update\_maternity\_paternity</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Update an existing maternity/paternity record for an employee</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_delete_maternity_paternity" data-action-label="Delete Maternity/Paternity" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Delete Maternity/Paternity</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_delete_maternity_paternity" aria-label="Copy peoplehr_delete_maternity_paternity"><code className="connector-page-code">peoplehr\_delete\_maternity\_paternity</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Delete a maternity/paternity record. Requires MaternityPaternityTxnId — use get\_maternity\_paternity\_by\_employee first to...</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_get_right_to_work" data-action-label="Get Right To Work" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Right To Work</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_get_right_to_work" aria-label="Copy peoplehr_get_right_to_work"><code className="connector-page-code">peoplehr\_get\_right\_to\_work</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve right to work / visa / work permit details for a specific employee. Use list\_employees to find the EmployeeId f...</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_create_right_to_work" data-action-label="Create Right To Work" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Create Right To Work</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_create_right_to_work" aria-label="Copy peoplehr_create_right_to_work"><code className="connector-page-code">peoplehr\_create\_right\_to\_work</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Add a new right to work / visa / work permit record for an employee. DocumentId here means the document reference number...</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_update_right_to_work" data-action-label="Update Right To Work" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Update Right To Work</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_update_right_to_work" aria-label="Copy peoplehr_update_right_to_work"><code className="connector-page-code">peoplehr\_update\_right\_to\_work</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Update an existing right to work record for an employee</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="peoplehr_delete_right_to_work" data-action-label="Delete Right To Work" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Delete Right To Work</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="peoplehr_delete_right_to_work" aria-label="Copy peoplehr_delete_right_to_work"><code className="connector-page-code">peoplehr\_delete\_right\_to\_work</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Delete a right to work record. Requires RightToWorkTxnId — use get\_right\_to\_work first to find it.</div>
      </div>
    </div>
  </div>
</div>


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