# IRIS Software Group HR API API

> IRIS Software Group HR API API on Apizie: 34 endpoints (Gets a list of Employees., Creates a new Employee., Gets a single Employee referenced by ID., Update an Employee referenced by ID., …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/business:iris-software-group-cascade/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `business:iris-software-group-cascade`
- Category: Business
- Status: byok
- Source: https://www.iris.co.uk/products/iris-cascade
- Page: https://zieapi.vercel.app/api/business/iris-software-group-cascade
- OpenAPI: https://zieapi.vercel.app/api/business/iris-software-group-cascade/openapi.json

Download Swagger Json in OAS2 Format.

## Endpoints

### Gets a list of Employees.
`GET https://zieapi.vercel.app/v1/business:iris-software-group-cascade/employees-get-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| $top | integer | no | Show only the first n items, maximum of 250, see [Paging -… |
| $skip | integer | no | Skip the first n items, see [Paging -… |
| $filter | string | no | Filter items by property values, see… |
| $select | array | no | Select properties to be returned, see… |
| $orderby | string | no | Order items by property values, see… |
| $count | boolean | no | Include count of items, see… |

### Creates a new Employee.
`POST https://zieapi.vercel.app/v1/business:iris-software-group-cascade/employees-create-new-employee` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Gets a single Employee referenced by ID.
`GET https://zieapi.vercel.app/v1/business:iris-software-group-cascade/employees-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Employee ID. |

### Update an Employee referenced by ID.
`POST https://zieapi.vercel.app/v1/business:iris-software-group-cascade/employees-update-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of Employee to update. |
| body | object | no | JSON request body |

### Gets a list of Jobs.
`GET https://zieapi.vercel.app/v1/business:iris-software-group-cascade/jobs-get-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| $top | integer | no | Show only the first n items, maximum of 250, see [Paging -… |
| $skip | integer | no | Skip the first n items, see [Paging -… |
| $filter | string | no | Filter items by property values, see… |
| $select | array | no | Select properties to be returned, see… |
| $orderby | string | no | Order items by property values, see… |
| $count | boolean | no | Include count of items, see… |

### Creates a new Job.
`POST https://zieapi.vercel.app/v1/business:iris-software-group-cascade/jobs-create-new-job` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Gets a single Job referenced by an ID.
`GET https://zieapi.vercel.app/v1/business:iris-software-group-cascade/jobs-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Job ID. |

### Update a Job referenced by an ID.
`POST https://zieapi.vercel.app/v1/business:iris-software-group-cascade/jobs-update-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of the Job to update. |
| body | object | no | JSON request body |

### Gets a list of Hierarchy Nodes.
`GET https://zieapi.vercel.app/v1/business:iris-software-group-cascade/hierarchy-get-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| $top | integer | no | Show only the first n items, maximum of 250, see [Paging -… |
| $skip | integer | no | Skip the first n items, see [Paging -… |
| $filter | string | no | Filter items by property values, see… |
| $select | array | no | Select properties to be returned, see… |
| $orderby | string | no | Order items by property values, see… |
| $count | boolean | no | Include count of items, see… |

### Gets a single Hierarchy Node by ID.
`GET https://zieapi.vercel.app/v1/business:iris-software-group-cascade/hierarchy-get-node-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Hierarchy Node ID. |

### Gets a Hierarchy Path by ID. The path is an array of nodes traversed from the root to the node specified.
`GET https://zieapi.vercel.app/v1/business:iris-software-group-cascade/hierarchy-get-path-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Hierarchy Node ID. |

### Gets a list of Bank Details.
`GET https://zieapi.vercel.app/v1/business:iris-software-group-cascade/bank-details-get-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| $top | integer | no | Show only the first n items, maximum of 250, see [Paging -… |
| $skip | integer | no | Skip the first n items, see [Paging -… |
| $filter | string | no | Filter items by property values, see… |
| $select | array | no | Select properties to be returned, see… |
| $orderby | string | no | Order items by property values, see… |
| $count | boolean | no | Include count of items, see… |

### Creates a Bank Details.
`POST https://zieapi.vercel.app/v1/business:iris-software-group-cascade/bank-details-create-bank-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Gets a single Bank Details by an ID.
`GET https://zieapi.vercel.app/v1/business:iris-software-group-cascade/bank-details-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Bank Details ID. |

### Updates Bank Details.
`POST https://zieapi.vercel.app/v1/business:iris-software-group-cascade/bank-details-update-bank-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of Bank Details to update. |
| body | object | no | JSON request body |

### Gets a list of Absence Reasons
`GET https://zieapi.vercel.app/v1/business:iris-software-group-cascade/absence-reasons-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| $top | integer | no | Show only the first n items, maximum of 250, see [Paging -… |
| $skip | integer | no | Skip the first n items, see [Paging -… |
| $filter | string | no | Filter items by property values, see… |
| $select | array | no | Select properties to be returned, see… |
| $orderby | string | no | Order items by property values, see… |
| $count | boolean | no | Include count of items, see… |

### Gets a single Absence Reason referenced by ID.
`GET https://zieapi.vercel.app/v1/business:iris-software-group-cascade/absence-reasons-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Absence Reason ID. |

### Gets a single Employee Absence Reason referenced by ID.
`GET https://zieapi.vercel.app/v1/business:iris-software-group-cascade/absence-reasons-get-employee-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Absence Reason ID. |
| employeeId | string | yes | Employee ID. |

### Gets a list of Entitlements.
`GET https://zieapi.vercel.app/v1/business:iris-software-group-cascade/entitlements-get-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| $top | integer | no | Show only the first n items, maximum of 250, see [Paging -… |
| $skip | integer | no | Skip the first n items, see [Paging -… |
| $filter | string | no | Filter items by property values, see… |
| $select | array | no | Select properties to be returned, see… |
| $orderby | string | no | Order items by property values, see… |
| $count | boolean | no | Include count of items, see… |

### Gets an Entitlement by ID.
`GET https://zieapi.vercel.app/v1/business:iris-software-group-cascade/entitlements-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Entitlement ID. |

### Gets a list of Absences.
`GET https://zieapi.vercel.app/v1/business:iris-software-group-cascade/absences-get-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| $top | integer | no | Show only the first n items, maximum of 250, see [Paging -… |
| $skip | integer | no | Skip the first n items, see [Paging -… |
| $filter | string | no | Filter items by property values, see… |
| $select | array | no | Select properties to be returned, see… |
| $orderby | string | no | Order items by property values, see… |
| $count | boolean | no | Include count of items, see… |

### Creates a new Absence.
`POST https://zieapi.vercel.app/v1/business:iris-software-group-cascade/absences-create-new-absence` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Gets a single Absence referenced by ID.
`GET https://zieapi.vercel.app/v1/business:iris-software-group-cascade/absences-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Absence ID. |

### Update an Absence referenced by ID.
`POST https://zieapi.vercel.app/v1/business:iris-software-group-cascade/absences-update-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of the Absence to update. |
| body | object | no | JSON request body |

### Delete an Absence referenced by ID.
`POST https://zieapi.vercel.app/v1/business:iris-software-group-cascade/absences-delete-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of the Absence to delete. |

### Gets a list of all Absence Days.
`GET https://zieapi.vercel.app/v1/business:iris-software-group-cascade/absence-days-get-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| $top | integer | no | Show only the first n items, maximum of 250, see [Paging -… |
| $skip | integer | no | Skip the first n items, see [Paging -… |
| $filter | string | no | Filter items by property values, see… |
| $select | array | no | Select properties to be returned, see… |
| $orderby | string | no | Order items by property values, see… |
| $count | boolean | no | Include count of items, see… |

### Creates an Absence Day.
`POST https://zieapi.vercel.app/v1/business:iris-software-group-cascade/absence-days-create-absence-day` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Gets a single Absence Day based on ID given.
`GET https://zieapi.vercel.app/v1/business:iris-software-group-cascade/absence-days-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Absence Day ID. |

### Updates an Absence Day.
`POST https://zieapi.vercel.app/v1/business:iris-software-group-cascade/absence-days-update-absence-day` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of the Absence Day to update. |
| body | object | no | JSON request body |

### Deletes an Absence Day.
`POST https://zieapi.vercel.app/v1/business:iris-software-group-cascade/absence-days-delete-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The ID of the Absence Day to delete. |

### Gets a list of Benefits.
`GET https://zieapi.vercel.app/v1/business:iris-software-group-cascade/benefits-get-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| $top | integer | no | Show only the first n items, maximum of 250, see [Paging -… |
| $skip | integer | no | Skip the first n items, see [Paging -… |
| $filter | string | no | Filter items by property values, see… |
| $select | array | no | Select properties to be returned, see… |
| $orderby | string | no | Order items by property values, see… |
| $count | boolean | no | Include count of items, see… |

### Gets a single Benefit referenced by ID.
`GET https://zieapi.vercel.app/v1/business:iris-software-group-cascade/benefits-get-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Benefit ID. |

### Gets a set of Public Holidays with locations.
`GET https://zieapi.vercel.app/v1/business:iris-software-group-cascade/public-holidays-get-locations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| $top | integer | no | Show only the first n items, maximum of 250, see [Paging -… |
| $skip | integer | no | Skip the first n items, see [Paging -… |
| $filter | string | no | Filter items by property values, see… |
| $select | array | no | Select properties to be returned, see… |
| $orderby | string | no | Order items by property values, see… |
| $count | boolean | no | Include count of items, see… |

### Gets a location based Public Holiday list by ID.
`GET https://zieapi.vercel.app/v1/business:iris-software-group-cascade/public-holidays-get-location-list-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | Public Holiday ID. |

## Example
```
curl "https://zieapi.vercel.app/v1/business:iris-software-group-cascade/employees-get-list" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the IRIS Software Group HR API API?
Create a free Apizie key, then send GET https://zieapi.vercel.app/v1/business:iris-software-group-cascade/employees-get-list with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the IRIS Software Group HR API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. IRIS Software Group HR API itself also needs your own key from api.iris.co.uk.

### Can AI agents use the IRIS Software Group HR API API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key business:iris-software-group-cascade.

### What is the status of the IRIS Software Group HR API API?
Needs your own provider key (bring your own key)