Coming soon to the IRIS HR API

Maternity

Maternity will soon be available in the IRIS HR API.

The initial release will include GET methods only. Functionality to update Maternity records is planned for a future release.

This read-only endpoint will provide secure access to the detailed records held on the HR Maternity screen in IRIS Cascade, making it easy to pull up-to-date records into reporting tools, dashboards, or third-party systems. It reduces manual exports and ensures consistent, accurate HR data across your integrations.

Paternity and Adaption endpoints will be released in future updates.

XML Support

XML Support will soon be available in the IRIS HR API.

We will soon add first-class XML support to the API. You will be able to send requests in XML and receive responses in XML as an alternative to the existing JSON format. This gives you greater flexibility when integrating with systems or workflows that prefer or require XML.

How it will work

  • Both formats will be supported side‑by‑side; existing JSON behaviour will remain unchanged and continue to be the default.

  • Clients will select the format using standard HTTP headers (Content-Type for requests and Accept for responses). If no preference is given, the API will continue to return JSON.

  • Error responses, validation messages and the same data fields will be available in XML to match those currently provided in JSON.

What to expect

  • We will publish sample requests and responses on our swagger documentation along side our current JSON examples.

  • Existing integrations will not be disrupted; this is an additive change designed to make integration easier for teams that rely on XML.

Become an early adopter

Interested in becoming an early adopter of the features mentioned? Send us an email. If we have capacity, we will get in touch with you.