Coming soon to the IRIS HR API

User Defined Fields

Update: 16 July 2025

User Defined Fields will soon be available in the IRIS HR API.

The initial release will include GET methods only. Functionality to update User Defined Fields is planned for a future release.

As well as obtaining data from basic user defined fields, you will be able to:

  • Query a schema endpoint that provides the details of a user-defined field such as Data type, Length etc.

  • Query user-defined fields on built-in screens as well as user-defined screens.

    Linked fields (fields obtaining data from another screen) and calculated fields will not be populated with values in the initial release.

Deployment plan

We are launching the user defined fields endpoints as a beta service. To start, the endpoint will sit behind a feature flag, and you will need to request access to it. We plan to release the beta on 29 July 2025.

Find out how to become an early adopter of this feature.

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.