v1.0.0 to v1.0.0

23 added, 0 removed. Audit A to A.

---

name: cascade-hr

description: |

IRIS Cascade HR integration via Apideck's HRIS unified API — same methods work across every connector in HRIS, switch by changing `serviceId`. Use when the user wants to read or sync employees, departments, payrolls, and time-off records in IRIS Cascade HR. Routes through Apideck with serviceId "cascade-hr".

license: Apache-2.0

alwaysApply: false

metadata:

author: apideck

version: "1.0.0"

serviceId: cascade-hr

unifiedApis: ["hris"]

authType: oauth2

tier: "2"

verified: true

+ difficulty: involved

+ partnershipRequired: false

+ sandboxAvailable: true

---

# IRIS Cascade HR (via Apideck)

Access IRIS Cascade HR through Apideck's **HRIS** unified API — one of 58 HRIS connectors that share the same method surface. Code you write here ports to BambooHR, Workday, Deel and 54 other HRIS connectors by changing a single `serviceId` string. Apideck handles auth, pagination, rate limiting, and retries so you don't write per-tenant IRIS Cascade HR plumbing.

## Quick facts

- **Apideck serviceId:** `cascade-hr`

- **Unified API:** HRIS

- **Auth type:** oauth2

- **Gotchas:** [page](https://developers.apideck.com/apis/hris/cascade-hr/gotchas)

- **IRIS Cascade HR docs:** https://www.iris.co.uk

- **Homepage:** https://www.iris.co.uk/products/iris-cascade-b/

+ ## At a glance

+ - **Implementation difficulty:** involved — Credentials Issued by IRIS on Request + Data-Owner Approval

+ - **Vendor partnership required:** no ([developer portal](https://help-iris.co.uk/hr/cascade/api/getstart/request-access-api.htm)) — IRIS states it works with software developers.

+ - **Apideck-managed credentials:** not available — Each consumer uses the client key and secret IRIS issued to them.

+ - **Account type required:** An IRIS Cascade HR system (Production or Practice); writes need a read/write key, not a read-only one.

+ - **Consumer access level:** A named person receives the credentials, and whoever owns the consumer's HR data must approve the request.

+ - **Sandbox:** available ([signup](https://help-iris.co.uk/hr/cascade/api/getstart/request-access-api.htm)) — Partner Sandbox on email request: basic data and UI access, shared with other third parties. Cascade customers can also ask for a Practice system.

+ - **Costs:** No additional API charge for IRIS Cascade HR customers, per IRIS's API FAQ (October 2022).

+ - **Rate limits:** 1.6 requests/second and 100/minute per IP; 144,000/day per application (hard quota).

+ - **Authentication:** Client credentials flow; no user consent step.

+ - **Webhooks:** Virtual webhooks - employee created, updated and terminated events

+ **Important to know:**

+ - Each consumer requests API credentials from IRIS by email; the connection works only once IRIS issues the client key and secret.

+ - IRIS's Fair Use Policy allows it to throttle, cap or disable API access without warning, and forbids using the API to build a product that competes with IRIS's services.

+ > Facts synced from Apideck's connector metadata API — `GET /connector/connectors/cascade-hr` (`overview` field) is the live, authoritative version.

## When to use this skill

Activate this skill when the user explicitly wants to work with **IRIS Cascade HR** — for example, "sync employees in IRIS Cascade HR" or "list time-off requests in IRIS Cascade HR". This skill teaches the agent:

1. Which Apideck unified API covers IRIS Cascade HR (HRIS)

2. The correct `serviceId` to pass on every call (`cascade-hr`)

3. IRIS Cascade HR-specific auth and coverage caveats

For the full method surface (parameters, pagination, filtering), use your language SDK skill:

- [`apideck-node`](../../skills/apideck-node/), [`apideck-python`](../../skills/apideck-python/), [`apideck-dotnet`](../../skills/apideck-dotnet/), [`apideck-java`](../../skills/apideck-java/), [`apideck-go`](../../skills/apideck-go/), [`apideck-php`](../../skills/apideck-php/), or [`apideck-rest`](../../skills/apideck-rest/)

For the raw OpenAPI spec:

- **HRIS:** [https://specs.apideck.com/hris.yml](https://specs.apideck.com/hris.yml) · [API Explorer](https://developers.apideck.com/api-explorer?id=hris)

## Minimal example (TypeScript)

```typescript

import { Apideck } from "@apideck/unify";

const apideck = new Apideck({

apiKey: process.env.APIDECK_API_KEY,

appId: process.env.APIDECK_APP_ID,

consumerId: "your-consumer-id",

});

// List employees in IRIS Cascade HR

const { data } = await apideck.hris.employees.list({

serviceId: "cascade-hr",

});

```

## Portable across 58 HRIS connectors

The Apideck **HRIS** unified API exposes the same methods for every connector in its catalog. Switching from IRIS Cascade HR to another HRIS connector is a one-string change — no rewrite, no new SDK.

```typescript

// Today — IRIS Cascade HR

await apideck.hris.employees.list({ serviceId: "cascade-hr" });

// Tomorrow — same code, different connector

await apideck.hris.employees.list({ serviceId: "bamboohr" });

await apideck.hris.employees.list({ serviceId: "workday" });

```

This is the compounding advantage of using Apideck over integrating IRIS Cascade HR directly: code against the unified HRIS API once, gain access to every connector in it. New connectors Apideck adds become available to your app without code changes.

## Authentication

- **Type:** OAuth 2.0

- **Managed by:** Apideck Vault — Apideck handles the full OAuth dance (authorization code flow, token exchange, refresh). Never ask the user for API keys or tokens directly.

- **User setup:** Users authorize via the Vault modal. Connection state progresses `available → added → authorized → callable`.

- **Token refresh:** automatic. Expired tokens are refreshed transparently on the next API call.

See [`apideck-best-practices`](../../skills/apideck-best-practices/) for Vault setup, connection lifecycle, and handling re-auth flows.

## Verifying coverage

Not every HRIS operation is supported by every connector. Always verify before assuming a method works:

```bash

curl 'https://unify.apideck.com/connector/connectors/cascade-hr' \

-H "Authorization: Bearer ${APIDECK_API_KEY}" \

-H "x-apideck-app-id: ${APIDECK_APP_ID}"

```

See [`apideck-connector-coverage`](../../skills/apideck-connector-coverage/) for patterns around `UnsupportedOperationError` and connector-specific fallbacks.

## Escape hatch: Proxy API

When an endpoint isn't covered by the HRIS unified API, use Apideck's Proxy to call IRIS Cascade HR directly — Apideck injects auth headers and handles token refresh. Set `x-apideck-downstream-url` to the target endpoint on IRIS Cascade HR's own API:

```bash

curl 'https://unify.apideck.com/proxy' \

-H "Authorization: Bearer ${APIDECK_API_KEY}" \

-H "x-apideck-app-id: ${APIDECK_APP_ID}" \

-H "x-apideck-consumer-id: ${CONSUMER_ID}" \

-H "x-apideck-service-id: cascade-hr" \

-H "x-apideck-downstream-url: <target endpoint on IRIS Cascade HR>" \

-H "x-apideck-downstream-method: GET"

```

See [IRIS Cascade HR's API docs](https://www.iris.co.uk) for available endpoints.

## Sibling connectors

Other **HRIS** connectors that share this unified API surface (same method signatures, just change `serviceId`):

[`bamboohr`](../bamboohr/), [`workday`](../workday/), [`deel`](../deel/) *(beta)*, [`hibob`](../hibob/), [`personio`](../personio/), [`adp-ihcm`](../adp-ihcm/) *(beta)*, [`adp-workforce-now`](../adp-workforce-now/) *(beta)*, [`paychex`](../paychex/) *(beta)*, and 49 more.

## See also

- [HRIS OpenAPI spec](https://specs.apideck.com/hris.yml) · [API Explorer](https://developers.apideck.com/api-explorer?id=hris)

- [`apideck-connector-coverage`](../../skills/apideck-connector-coverage/) — programmatic coverage checks

- [`apideck-best-practices`](../../skills/apideck-best-practices/) — architecture, Vault, pagination, error handling

- [`apideck-node`](../../skills/apideck-node/) — TypeScript / Node SDK patterns

- [IRIS Cascade HR official docs](https://www.iris.co.uk)