PeopleHR - How do I link my account?

Last updated: May 28, 2025

Overview

This guide will walk you through creating an API key within PeopleHR and entering it into the linking flow.

Prerequisites

Please ensure you fulfill all the requirements to set up the integration:

  • You are an Administrator in your company's PeopleHR instance, or someone has shared their access with you.

Instructions

Step 1: Generating your API key

  1. In your PeopleHR account, click Access in the top left hand corner, and select HR Admin.

  2. Go to Settings on the left sidebar. Select API and click the + icon

  3. On the API Key Management screen, type in a name for the key

  4. For the application actions, select all for Employee, Salary, Absence, and/or Holiday, depending on your use case. Below is an example of Employee.

  5. Press Save. Copy and store your Key in a safe place.

Step 2: Enter your API key in the linking flow

Notes