New Award List Endpoints

External API partners integrating with the EH Payroll API can now programmatically retrieve the awards installed or installing on a business.

Why this matters:

Previously, checking award status required manual verification in the UI - a major bottleneck for partners managing awards across multiple businesses at scale.

To address this, we have introduced two new read-only endpoints providing full visibility into award management.

New Endpoints

• GET api/v2/business/{businessId}/award
  • Description: Returns awards that are installed or have commenced installation, along with their status and latest version date.
  • Parameters: Supports an optional ?status= filter.

• GET api/v2/business/{businessId}/award/installed
  • Description: Returns a streamlined list of only the awards currently installed on the business.
  • Response fields: id, award id, and name.

‍