HR Partner API

Name: HR Partner API
Brand: HR Partner API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentHR recruitingEmployee ManagementapiKey3 EndpointsREST

For Agents

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

Install Jentic One Beta

Connect the HR Partner API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the HR Partner API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with HR Partner API.

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

GET STARTED

Start building with HR Partner API

Explore with Jentic

View OpenAPI Document

Use Cases

Patterns agents use HR Partner API for, with concrete tasks.

★ 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.

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.

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.

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 the MAXsystem vault and refreshes the access token between calls.

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

Key Endpoints

3 endpoints — jentic publishes the only available openapi specification for hr partner api, keeping it validated and agent-ready.

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

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

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

HR Partner API keys are stored encrypted in the Jentic vault (MAXsystem). Jentic exchanges the key for an access token at execution time and rotates the token automatically — neither value enters the agent's prompt.

Intent-based discovery

Agents search by intent (e.g., 'list HR resources') and Jentic returns the matching HR Partner operation along with the auth flow handled transparently.

Time to first call

Direct integration: a few hours for the token-exchange auth pattern and resource handling. Through Jentic: under 30 minutes.

FAQs

Specific to using HR Partner API through Jentic.

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 at https://app.jentic.com/sign-up.

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 the MAXsystem vault 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 the MAXsystem vault. 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.