Getting started

The Cascade HR API (Application Programming Interface) allows IRIS partners and customers to create business integrations easily and independently, between their IRIS software and third party or internal solutions.

HR API enables partners to create new opportunities and routes to market, by allowing seamless transfer of HR data into workflows, processes, and systems.

The IRIS development team has used Swagger Open API to document our RESTful API.

To gain access to the Swagger definition, please contact the Product Owner -

The API is implemented as a RESTful web service over HTTPS using certain HTTP verbs. The response is returned in JSON format.

To make API calls to IRIS, you must embed an access token into the header of each call.

HR API tokens are generated using OAuth 2.0, in line with RFC6749. Find out more about OAuth 2.0.

You will have received a Client Key and a Client Secret from IRIS in a separate email. You need these credentials to generate a token.

Each user has their own specific Client Key and Client Secret. Signing a request identifies the sender and prevents the request from being altered. 

The Client Secret is the equivalent of a password and should not be stored in plain text. Only store an encrypted version of the Client Secret to reduce the chance of it being compromised.