canonical: https://jentic.com/apis/hrpartner.io/hrpartner

# HR Partner API

Jentic publishes the only available OpenAPI specification for HR Partner API, keeping it validated and agent-ready. The HR Partner API is a small but focused surface for HR Partner's people-management platform - exchange an API key for an access token, list resources, and retrieve a single resource by id. The current public surface is intentionally narrow; integrations centre on reading reference data after authenticating. Useful for lightweight read-only HR integrations and AI agents that need access tokens scoped to a tenant.

## For AI agents

Authenticate against HR Partner and read resources from an HR Partner workspace via 3 endpoints.

## Scope

Does not handle payroll, time-off requests, or applicant tracking - use for authenticating to HR Partner and reading HR resource records only.

## Capabilities

- Exchange an API key for a short-lived access token via `/auth/token`
- List available HR resources for the authenticated tenant
- Retrieve a single HR resource by its identifier
- Bootstrap downstream HR integrations that need an HR Partner access token

## Use cases

### HR Resource Reference Sync

Sync HR Partner reference resources (departments, locations, or other tenant-defined collections) into a downstream data store on a schedule. The agent calls POST `/auth/token` to obtain a token, then GET /resources to list the universe and GET `/resources/{id}` for any deeper detail. Lightweight read-only integration with minimal moving parts.

Example prompt: Authenticate via POST `/auth/token`, list resources via GET /resources, and store the result in the integration database.

### Auth Bootstrap for Custom Integrations

Use HR Partner's auth endpoint as the access-token broker for custom HR scripts. The agent calls POST `/auth/token` at startup and reuses the resulting token for the lifetime of the run. Keeps long-lived API keys out of every downstream call.

Example prompt: Call POST `/auth/token` with the stored API key and cache the returned access token for use across subsequent reads.

### Single Resource Lookup Helper

Power an internal helper that looks up a single HR Partner resource by id when a workflow surfaces a reference. The agent authenticates, then calls GET `/resources/{id}` with the supplied id and returns the structured payload. Useful for workflow engines that resolve HR ids on demand.

Example prompt: Resolve resource id 555 by calling GET `/resources/{id}` with id=555 after obtaining a token.

### AI HR Lookup Agent via Jentic

Plug HR Partner into an AI agent through Jentic so the agent can authenticate and look up resources without you maintaining custom token-handling code. Jentic stores the API key in your Jentic One instance and refreshes the access token between calls.

Example prompt: Search Jentic for 'list HR Partner resources', load the schema, and execute to return the resource list for the tenant.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/auth/token` | Exchange API key for an access token |
| GET | `/resources` | List HR Partner resources |
| GET | `/resources/{id}` | Get a single HR Partner resource |

## Key resources

- **Authentication** — Single POST endpoint that exchanges an API key for an access token.
- **Resources** — List and read HR Partner reference resources for the authenticated tenant.

## Why Jentic

- **Setup:** Wiring HR Partner by hand means exchanging its X-API-Key header for an access token, refreshing that token yourself, and keeping the api.hrpartner.io host straight across the resource endpoints. Through Jentic you install once, import the HR Partner API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** HR Partner serves read-only resource records, so scope your agent to the operations it needs, such as listing resources or reading one by id. You choose which calls are in the allowed set, and every operation here is a read, so nothing mutates the data.
- **Credential handling:** Your HR Partner API key is stored once, encrypted, by your own Jentic One instance, which exchanges it for an access token at execution time. Neither value enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'list HR resources' or 'read a resource record', and Jentic returns the matching HR Partner operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **BambooHR API** — Larger SMB HR platform with employee, time-off, and reporting endpoints.
- **Homerun Public API** — ATS that complements HR Partner by handling pre-hire applicant tracking.
- **HrFlow.ai API** — AI parsing, tagging, and matching layer for candidate and employee data.

## FAQ

### Why is there no official OpenAPI spec for HR Partner API?

HR Partner does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call HR Partner API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the HR Partner API use?

An API key. You exchange the key for a short-lived access token via POST `/auth/token`, then pass the token on subsequent calls. Jentic stores the API key encrypted in your Jentic One instance and handles the token exchange.

### Can I list all resources in my HR Partner workspace?

Yes. GET /resources returns the resource collection for the authenticated tenant. Use GET `/resources/{id}` to fetch a single resource's full detail by id when you need more than the list view.

### What are the rate limits for the HR Partner API?

HR Partner applies tenant-level rate limits that scale with plan tier. The current spec exposes only three endpoints, so most flows are well within bounds - back off on 429 responses on tight polling loops and cache resources where reasonable.

### How do I authenticate to the HR Partner API through Jentic?

Run pip install jentic, search for 'HR Partner access token', load the POST `/auth/token` schema, and execute with the API key kept in your Jentic One instance. Jentic exchanges the key for the access token automatically.

### Can the HR Partner API write back to employee records?

Not in this spec. The current public surface exposes auth and read-only resource endpoints only. Treat the integration as read-only until additional endpoints are added by HR Partner.

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

Yes. Because you run Jentic One yourself, your own rules decide which HR Partner operations the agent may call, so you can allow just listing resources with GET /resources, reading a single record with GET `/resources/{id}`, and exchanging the key for a token with POST `/auth/token.` Every operation on this API is a read, so nothing your agent runs can mutate HR Partner data. You control which of these calls sit in the agent's allowed set and which credentials it may use.