A new API - Planner Events Endpoint workflow is now available in Workflow Hub.

The workflow provides a secure API endpoint that allows organisations and authorised third-party systems to retrieve Planner event information from Sense HR as structured JSON.

This includes holiday, sickness and other Time Off and Working events, with options to retrieve information for a particular date range or selected employees.

The Planner Events API can return information about events including:

Event records can include dates, times, approval status and other relevant event information.

API - Planner Events Endpoint in Workflow Hub

External systems can access Planner information through a single endpoint instead of organisations needing to build separate processes for different types of absence or working events.

API requests can be narrowed to a particular date range and, where required, specific employees.

A request without these filters returns Planner events for the current calendar year.

Integrations can request the period and employee population they need rather than processing unnecessary Planner information.

Planner event records use the same senseHrId as the Employee Core Data API. This is the employee’s unique Sense HR system identifier and is separate from the Employee ID stored in Employment Details.

This means employee information retrieved through the Employee Core Data API can be matched directly with that employee’s Planner events.

Employee records and Planner events can be matched reliably across the two APIs using the shared senseHrId.

Access to the endpoint is protected using an API key.

Organisations can also use optional IP allow-listing to restrict requests to approved source IP addresses.

Organisations can control which integrations can access Planner data and, where required, where those requests can originate.

Public holidays are not returned by the Planner Events API.

Part-of-shift information for events that are not linked to an entitlement is also not currently included. Support for this is planned following a fix.

For endpoint details, authentication, filtering, response fields, request examples and data-handling guidance, see:

👉 Calendar Events API

Retrieve calendar events — holiday, sickness, and other working and Time Off records — from Sense HR through a single endpoint.

You can also use the Employee Core Data API to retrieve employee information that can be matched to Planner events using the shared Sense HR employee identifier.

The new Planner Events API makes it easier to connect Sense HR Planner information with other systems.

A single secure endpoint can return holiday, sickness and other Time Off and Working events for a selected date range and employee population, while using the same employee identifier as the Employee Core Data API for easier integration.