Skip to Main Content
HR API - Ideas Portal
Status Already exists
Categories New Endpoints
Created by Guest
Created on May 1, 2026

Expose User Defined Fields (UDFs) and additional compliance data (DBS, Right to Work, Badge Expiry) via the v2 REST API

Expose User Defined Fields and the standard compliance blocks (DBS, Right to Work, Badge Expiry, Notice Period) through the Cascade HR v2 REST API.


  • DBS expiry is a legal compliance field for any organisation working with vulnerable adults or children — automated downstream sync prevents scheduling someone with a lapsed DBS

  • UDFs are the primary mechanism Cascade customers use to extend the data model (e.g. custom certifications, internal references, contract clauses) — currently all of that customer-specific data is invisible to integrations

  • Right to Work expiry feeds directly into HMRC compliance and right-to-work audits

  • Attach files
  • Admin
    Bobby Bates
    Jun 24, 2026

    All UDF data is already available to GET in the API. You can find more about this here: https://swagger.hrapi.co.uk/#/UserDefinedFields


    Please note UDF is for fields created by you, if its a built in screen with a built in field then this wont show in the UDF endpoint