---
title: How to integrate with People HR
description: This guide will walk you through creating an API key within PeopleHR and entering it into the Ravio onboarding flow.
---
[Skip to content](https://help.ravio.com/peoplehr#main-content)
English
Show submenu for translations
Open main navigation
Close main navigation
- English
Show submenu for translations
- [Contact us](https://fa3fd.share-eu1.hsforms.com/2IkfMVpstTUWvffP5uESSLg)
[Contact us](https://fa3fd.share-eu1.hsforms.com/2IkfMVpstTUWvffP5uESSLg)
How can we help you?
- There are no suggestions because the search field is empty.
1. [Ravio Help Centre](https://help.ravio.com/?hsLang=en)
2. [Integrations and data sharing](https://help.ravio.com/integrations-and-data-sharing?hsLang=en)
3. [Setting up your HRIS integration](https://help.ravio.com/integrations-and-data-sharing?hsLang=en#setting-up-your-hris-integration)
# How to integrate with People HR
## This guide will walk you through creating an API key within PeopleHR and entering it into the Ravio onboarding flow.
### **Overview**
This guide will walk you through creating an API key within PeopleHR and entering it into the Ravio onboarding flow.
#### Prerequisites
Please ensure you fulfil all the requirements to set up the integration:
- You are a **HR Admin** in your company's PeopleHR instance, or someone has shared their access with you.
The way that you check this is by making sure you can see the **HR Admin** option when you click **Access** in the top left corner.
#### Step by Step Instructions
1. **Generating your API key**
In your PeopleHR account, click **Access** in the top left hand corner, and select **HR Admin** (You may not see the full list in the screenshot below).
Go to **Settings** on the left sidebar. Select API and click the + icon.
2. **Assigning the Correct Entitlements**
On the API Key Management screen, type in a name for the key.
For the application actions, **select all for Employee, Salary and History.** Press **Save**
Copy and store your Key in a safe place.
3. **Enter your API key in the Ravio Onboarding flow**
**Finally, enter your copied API key from the previous step in the Onboarding flow.**
****
#### **Custom fields**
PeopleHR has specific limitations with their API regarding sharing any custom fields. The only custom fields that PeopleHR allows access to through their API are 5 preset fields:
- APIColumn1
- APIColumn2
- APIColumn3
- APIColumn4
- APIColumn5
If you want to expose custom data you need to populate one of 5 preset fields that PeopleHR have made available with the data and let Ravio know which field you have used.
Ravio will then make this mapping on our side to make sure the right data is present.
[PeopleHR API Documentation](https://apidocs.peoplehr.com/#tag/Employee)
- [Getting started](https://help.ravio.com/getting-started?hsLang=en#main-content)
- [Onboarding](https://help.ravio.com/getting-started?hsLang=en#onboarding)
- [Benchmarking](https://help.ravio.com/getting-started?hsLang=en#benchmarking)
- [Pay equity](https://help.ravio.com/getting-started?hsLang=en#pay-equity)
- [Video guides](https://help.ravio.com/getting-started?hsLang=en#video-guides)
- [Using Ravio with AI tools](https://help.ravio.com/getting-started?hsLang=en#using-ravio-with-ai-tools)
- [Integrations and data sharing](https://help.ravio.com/integrations-and-data-sharing?hsLang=en#main-content)
- [Setting up your HRIS integration](https://help.ravio.com/integrations-and-data-sharing?hsLang=en#setting-up-your-hris-integration)
- [Variable and equity data](https://help.ravio.com/integrations-and-data-sharing?hsLang=en#variable-and-equity-data)
- [Manually sharing employee data](https://help.ravio.com/integrations-and-data-sharing?hsLang=en#manually-sharing-employee-data)
- [Setting up your ATS integration](https://help.ravio.com/integrations-and-data-sharing?hsLang=en#setting-up-your-ats-integration)
- [Managing your integration](https://help.ravio.com/integrations-and-data-sharing?hsLang=en#managing-your-integration)
- [Video guides](https://help.ravio.com/integrations-and-data-sharing?hsLang=en#video-guides)
- [Ravio feature guides](https://help.ravio.com/ravio-feature-guides?hsLang=en#main-content)
- [Salary bands](https://help.ravio.com/ravio-feature-guides?hsLang=en#salary-bands)
- [Explore the market](https://help.ravio.com/ravio-feature-guides?hsLang=en#explore-the-market)
- [Employee mapping & levelling](https://help.ravio.com/ravio-feature-guides?hsLang=en#employee-mapping-levelling)
- [Manage my data](https://help.ravio.com/ravio-feature-guides?hsLang=en#manage-my-data)
- [Settings](https://help.ravio.com/ravio-feature-guides?hsLang=en#settings)
- [Analyse your company](https://help.ravio.com/ravio-feature-guides?hsLang=en#analyse-your-company)
- [EU Pay Transparency](https://help.ravio.com/ravio-feature-guides?hsLang=en#eu-pay-transparency)
- [User and access management](https://help.ravio.com/user-and-access-management?hsLang=en#main-content)
- [User permissions](https://help.ravio.com/user-and-access-management?hsLang=en#user-permissions)
- [Single Sign On (SSO)](https://help.ravio.com/user-and-access-management?hsLang=en#single-sign-on-sso)
- [Benchmarking and data confidence](https://help.ravio.com/benchmarking-and-data-confidence?hsLang=en#main-content)
- [Data](https://help.ravio.com/benchmarking-and-data-confidence?hsLang=en#data)
- [Troubleshooting and support](https://help.ravio.com/troubleshooting-and-support?hsLang=en#main-content)
- [Contact support](https://help.ravio.com/troubleshooting-and-support?hsLang=en#contact-support)
- [FAQ](https://help.ravio.com/faq?hsLang=en#main-content)
- [Billing and invoices](https://help.ravio.com/faq?hsLang=en#billing-and-invoices)
- [Compliance](https://help.ravio.com/faq?hsLang=en#compliance)
- [Ravio community](https://help.ravio.com/faq?hsLang=en#ravio-community)
- [Sales](https://help.ravio.com/faq?hsLang=en#sales)
- [Integrations](https://help.ravio.com/integrations?hsLang=en)
- [Uncategorized](https://help.ravio.com/uncategorized?hsLang=en)
- Home
- Products
- Pricing
- Blog
- Company
[](http://ravio.com)
[mailto:hello@ravio.com](mailto:hello@ravio.com)
Copyright © 2026, Ravio Technologies Ltd