canonical: https://jentic.com/apis/peoplehr.com/peoplehr

# PeopleHR API

PeopleHR API for HR administration. All API calls need the API key to be passed along with the JSON data sent as part of the HTTP request. Rate limit: 30 calls per minute per IP address.

## For AI agents

Manage peoplehr.com resources and operations programmatically.

## Scope

Provides access to peoplehr.com resources and operations as documented in the OpenAPI specification.

## Capabilities

- Access and manage peoplehr.com resources
- Integrate peoplehr.com functionality into workflows
- Automate peoplehr.com operations

## Use cases

### peoplehr.com Integration

Integrate PeopleHR API into your application or workflow to automate operations and access resources programmatically.

Example prompt: Use the PeopleHR API to perform operations against peoplehr.com resources.

## Why Jentic

- **Setup:** Wiring PeopleHR by hand means setting the APIKey header on every request and working through its action-style Employee, EmployeeSalary, and EmployeeHoliday endpoints yourself. Through Jentic you install once, import the PeopleHR API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** PeopleHR exposes action-style operations such as GetEmployeeDetailById, CreateNewEmployee, and MarkAsLeaverById rather than resource ids in the URL path, so scoping is operations-only: limit the agent to the operations it needs, such as reading employee detail, and leave destructive ones like marking a leaver out of the allowed set unless you add them.
- **Credential handling:** Your PeopleHR API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'get an employee's details', and Jentic returns the matching PeopleHR operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## FAQ

### What authentication does the PeopleHR API use?

The PeopleHR API uses apiKey authentication. Through Jentic, credentials are stored encrypted and injected at execution time so they never enter the agent's context.

### How many endpoints does the PeopleHR API have?

The PeopleHR API exposes 116 endpoints across its surface area.

### Can I limit what my agent is allowed to do with the PeopleHR API?

Yes. Because Jentic One is self-hosted, you set the rules that decide which PeopleHR operations your agent may call and which credentials it uses. Since PeopleHR uses action-style operations rather than resource ids in the path, you scope at the operation level: allow only what the agent needs, such as GetEmployeeDetailById to read employee detail, while keeping destructive actions like CreateNewEmployee and MarkAsLeaverById out of the allowed set. The stored API key is injected only for the operations you have permitted, so anything you leave out of the set cannot be called.
