Documentation Index

Fetch the complete documentation index at: https://docs.thrivelearning.com/llms.txt

Use this file to discover all available pages before exploring further.

PeopleHR - How To Link My Account

Prev Next

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

Prerequisites

Ensure you fulfil the following 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.

  3. Select API and click the + icon

    Access products section featuring various HR tools and a search bar. API Key Management interface showing options to add and manage API keys.

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

    API Key Management interface for generating and managing application access keys.

  5. For the application actions, Select All for Employee, Salary, Absence, and/or Holiday, depending on your use case. Below is an example for Employee:

    List of application actions with descriptions for employee management APIs.

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

Step 2: Enter your API key in the linking flow

Input field for entering PeopleHR API key with instructions for users.

See More

For more information, go to: https://help.peoplehr.com/en/articles/1970068-creating-an-api-key