canonical: https://jentic.com/apis/humanforce.com/intellihr

# Humanforce intelliHR Public API

Jentic publishes the only available OpenAPI specification for intelliHR Public API, keeping it validated and agent-ready. The intelliHR Public API gives AI agents programmatic control over an intelliHR people-management platform. Agents manage the organizational backbone, creating and updating business entities, business units, and locations, and defining custom fields that extend employee records. They administer jobs and job changes, record extended leave, set employment conditions and probation, and manage pay grades and remuneration components. Requests authenticate with an API key in the Authorization header.

## For AI agents

Manage business entities, units, jobs, leave, and custom fields on an intelliHR platform. Requests authenticate with an API key.

## Scope

Does not process payroll payments or handle time-and-attendance capture. Use for HR records, jobs, and organizational structure only.

## Capabilities

- Create and update business entities, business units, and locations
- Define custom field definitions that extend employee records
- Administer jobs, job changes, probation, and job requirements
- Record extended leave and set employment conditions
- Manage pay grades and default remuneration components
- Drive onboarding templates and forms

## Use cases

### Agent HR Administration via Jentic

AI agents administer an intelliHR platform through Jentic without holding the API key in context. An agent searches by intent, receives the matching operation schema, and creates org structure, records leave, or updates jobs end to end. Jentic injects the key at execution time, so the agent never sees the secret while it maintains HR records.

Example prompt: Search Jentic for 'create an intelliHR business unit', load the POST /business-units schema, and create the unit with Jentic-managed credentials

### Organizational Structure Setup

An agent builds out the org backbone of an intelliHR tenant: it creates business entities and business units, adds locations, and defines the custom fields that capture the data each employee record needs. Because intelliHR exposes explicit entity, unit, and custom-field operations, the agent can stand up a consistent structure without a human clicking through admin screens.

Example prompt: Call POST /business-entities and POST /business-units to build the org structure, then define fields via custom-field-definitions

### Leave and Job Administration

An agent keeps employment records current by recording extended leave, setting employment conditions, and reflecting job changes as they happen. intelliHR exposes extended-leave, employment-condition, and job operations directly, so the agent can process HR events promptly instead of queueing them for a person to enter later.

Example prompt: Call POST /extended-leave to record leave and GET /employment-conditions to read the conditions that apply

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/business-entities` | List all business entities |
| POST | `/business-entities` | Create a new business entity |
| GET | `/business-units` | List all business units |
| POST | `/extended-leave` | Create an extended leave record |
| GET | `/employment-conditions` | List all employment conditions |
| GET | `/custom-field-definitions` | List all custom field definitions |

## Key resources

- **Business Entities and Units** — Create, read, and update the organizational structure of the tenant
- **Jobs and Leave** — Administer jobs and job changes and record extended leave
- **Custom Field Definitions** — Define custom fields that extend employee and record data

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 44 / 100
- **Maturity:** Non-Ready
- **Dimensions:**
  - Foundational Compliance: 25 / 100
  - Developer Experience & Jentic Compatibility: 80 / 100
  - AI-Readiness & Agent Experience: 33 / 100
  - Agent Usability: 72 / 100
  - Security: 50 / 100
  - AI Discoverability: 76 / 100
- **View full report:** https://jentic.com/apis/humanforce.com/intellihr/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the intelliHR Public API by hand means setting the Authorization API key header and sequencing the many entity, job, and leave operations across the platform yourself. Through Jentic you install once, import the intelliHR Public API from the API Directory, store the key, and your agent calls it.
- **Permission scoping:** The intelliHR Public API puts each record id in the URL path, so a rule can pin your agent to one business unit or job and the operations you choose. You decide which operations it may call, so create, update, and delete calls stay out unless you grant them.
- **Credential handling:** Your intelliHR 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 'create a business unit' or 'record extended leave', and Jentic returns the matching intelliHR operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **BambooHR** — Alternative HRIS for small and mid-sized companies
- **Rippling** — Alternative platform unifying HR, IT, and payroll
- **HiBob** — Alternative HR platform for modern, mid-sized teams

## FAQ

### Why is there no official OpenAPI spec for intelliHR Public API?

Humanforce does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call intelliHR Public API via structured tooling. It is validated against the live API and kept up to date. To run it on your own infrastructure, install Jentic One from its GitHub repo.

### What authentication does the intelliHR Public API use?

The intelliHR Public API authenticates requests with an API key sent in the Authorization header, per its OpenAPI spec. Through Jentic, the key is stored encrypted by your own Jentic One instance and injected at call time, so it never enters the agent's prompt or logs.

### Can I record extended leave with the intelliHR Public API?

Yes. Record extended leave with POST /extended-leave, list jobs with GET /jobs, and read employment conditions with GET /employment-conditions.

### How do I create a business unit with the intelliHR Public API through Jentic?

Search Jentic for 'create an intelliHR business unit', load the returned POST /business-units operation with its input schema, and your agent creates the unit with credentials injected at call time.

### Is there an intelliHR MCP server?

You don't need an MCP server to give your agent the intelliHR Public API. Jentic connects it directly from the API Directory: import it, store your key, and your agent calls it, discovering operations on demand instead of loading a separate server's tool definitions into its context.

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

Yes. The intelliHR Public API puts each record id in the URL path, so a rule can scope your agent to one business unit or job and the operations you pick, such as reading records without editing them. You choose which operations it may call, so create, update, and delete calls stay out unless you add them.