> For the complete documentation index, see [llms.txt](https://www.cakewalk.security/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.cakewalk.security/docs/platform-overview/connections-and-integrations/identity-sources/peoplehr.md).

# People HR

People HR connects to Cakewalk with an API key you create in the HR Admin product; for the shared flow, see [Connecting an HRIS](/docs/platform-overview/connections-and-integrations/connecting-an-hris.md).

### ✅ Before You Start

* You must be an admin in the People HR system.
* To check: click on access in the top left corner of your screen and confirm you can see **HR Admin** in the available products.

### 🛠 Connect

1. In Cakewalk, go to **Settings → Data Sources → Users** and select People HR.
2. In People HR, open the **HR Admin** product. In its sidebar, press **Settings**, then click **API**.
3. Click the **+** icon and enter a name for the API key.
4. Select the scopes for the key: enable **Employee**, which covers reading employee data.
5. Click **Save**.
6. Paste the created API token into the connection flow.

The first sync starts immediately. Sync details and cadence: [Connecting an HRIS](/docs/platform-overview/connections-and-integrations/connecting-an-hris.md).

### 📚 Related

* [HRIS and IdP](/docs/platform-overview/connections-and-integrations/hris-and-idp.md)
* [Connecting an HRIS](/docs/platform-overview/connections-and-integrations/connecting-an-hris.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://www.cakewalk.security/docs/platform-overview/connections-and-integrations/identity-sources/peoplehr.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
