IRIS HR API

Name: IRIS HR API
Brand: IRIS HR API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentHR recruitingEmployee Managementoauth234 EndpointsREST

For Agents

Read and write employee records, jobs, organisational hierarchy, and bank details inside an IRIS HR tenant for HRIS integrations and payroll feeds. Authenticated via OAuth 2.0 bearer tokens.

Install Jentic One Beta

Connect the IRIS HR API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the IRIS HR 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 IRIS HR API.

List, create, retrieve, and update employee records in an IRIS HR tenant

Manage jobs and assignments tied to employees, including title, role, and dates

Navigate the organisational hierarchy and resolve the path from any node to the root

GET STARTED

Start building with IRIS HR API

Explore with Jentic

View OpenAPI Document

Use Cases

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

★ HRIS-to-Payroll Synchronisation

Finance teams sync IRIS HR's authoritative employee, job, and bank-detail records into a payroll engine on a fixed cadence. Pulling /employees, /jobs, and /bankdetails on a schedule gives payroll a clean, up-to-date snapshot, avoiding manual exports and re-keying. Typical integration takes a few days for delta handling and error recovery.

Call GET /employees, /jobs, and /bankdetails since the last sync timestamp and upsert the records into the payroll system.

New-Hire Onboarding Automation

When a candidate is marked as hired in an ATS, an automation creates the matching employee record in IRIS HR via POST /employees, attaches the job through POST /jobs, and stores bank details. This eliminates the double-entry that typically delays first-day access and payroll setup. Integration is on the order of a week including ATS-side mapping.

POST /employees with the new hire's profile, then POST /jobs with start date and title, and POST /bankdetails with payroll information.

Org Chart and Hierarchy Reporting

BI dashboards and people analytics tools build live org charts by walking the IRIS hierarchy via GET /hierarchy, then resolving each node's full path with GET /hierarchy/{id}/path. Combined with /employees, this supports headcount-by-team views and span-of-control analysis without exporting CSVs.

Walk GET /hierarchy and call /hierarchy/{id}/path for each node to build a tree, then join with /employees to produce a headcount-by-team report.

Agent HR Lookups via Jentic

An AI assistant supporting HR ops can answer questions like 'how many employees report into the London office?' by calling IRIS HR through Jentic. The agent searches by intent, Jentic returns the matching operation with its OAuth-protected schema, and the bearer token is injected from the vault at execution.

Use Jentic to search for 'list employees in IRIS HR', load the GET /employees operation, and execute it with a hierarchy filter for the London node.

Key Endpoints

34 endpoints — the iris hr api (formerly cascade hr) provides programmatic access to core people-data records inside an iris hr tenant: employees, jobs, hierarchy nodes, bank details, contracts, salaries, absences, and more.

METHOD

PATH

DESCRIPTION

GET

/employees

List all employees

POST

/employees

Create a new employee

GET

/employees/{id}

Retrieve a specific employee by ID

PUT

/employees/{id}

Update an employee by ID

GET

/jobs

List jobs

POST

/jobs

Create a new job

GET

/hierarchy

List all hierarchy nodes

GET

/hierarchy/{id}/path

Get the path from a hierarchy node to the root

GET

/employees

List all employees

POST

/employees

Create a new employee

GET

/employees/{id}

Retrieve a specific employee by ID

PUT

/employees/{id}

Update an employee by ID

GET

/jobs

List jobs

POST

/jobs

Why Jentic?

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

Credential isolation

The IRIS HR OAuth 2.0 client credentials and refreshed bearer token are stored encrypted in the Jentic vault. At execution, Jentic obtains a fresh bearer and applies it to the Authorization header so the agent never handles secrets.

Intent-based discovery

Agents search by intent (e.g. 'list employees in IRIS HR') and Jentic returns the matching operation with its parameter schema, so the agent runs the right call without scanning 34 endpoints in the IRIS docs.

Time to first call

Direct IRIS HR integration: 3-5 days for OAuth handshake, token refresh, pagination, and error handling. Through Jentic: under 1 hour — search, load, execute.

FAQs

Specific to using IRIS HR API through Jentic.

What authentication does the IRIS HR API use?

IRIS HR uses OAuth 2.0 with bearer tokens on every request. Through Jentic, the OAuth client credentials and refreshed token are stored encrypted in the vault and the bearer is injected at execution time.

Can I create new employees through the IRIS HR API?

Yes. POST /employees creates a new employee record, and POST /jobs attaches a job to the employee. PUT /employees/{id} updates an existing record by ID.

How do I read the organisation's hierarchy?

Use GET /hierarchy to list all nodes and GET /hierarchy/{id}/path to retrieve the full path from any node back to the root, which gives you each level of the organisational tree.

What are the rate limits for the IRIS HR API?

IRIS does not publish hard per-minute rate limits in the spec; throughput is governed by tenant size and plan. Bulk syncs should run during off-peak hours and use delta filtering rather than full re-fetches.

How do I list employees through Jentic?

Search Jentic for 'list employees in IRIS HR', load the GET /employees operation, and execute it. Jentic exchanges the OAuth credentials for a bearer token and applies it to the request.

Does IRIS HR expose bank details for payroll feeds?

Yes. The /bankdetails resource exposes list and create operations so that payroll engines can read or update employee bank information without going through the IRIS HR UI.

IRIS HR API

Connect the IRIS HR API to your agent

Capabilities

Start building with IRIS HR API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs