A new API - Core Employee Data workflow is now available in Workflow Hub.

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

Instead of retrieving and combining information from multiple sources, integrations can access core employee, employment and reporting-line information through a single endpoint.

The Employee Core Data API can return employee information including:

Each employee record also includes a stable Sense HR identifier — senseHrId — that can be used to reference and match the employee across integrations.

API - Core Employee Data in Workflow Hub

External systems can retrieve a structured employee dataset from one endpoint instead of having to combine information from multiple Sense HR queries.

API requests can optionally be filtered to retrieve:

If no employee status is specified, the API returns active employees by default.

Integrations can request the workforce data they need rather than always processing the entire employee population.

Access to the endpoint is protected using an API key.

Organisations can also use IP allow-listing to restrict requests to approved source IP addresses, providing an additional level of access control where required.

An API key is generated when the workflow is deployed and must be stored securely.

Organisations have control over which integrations can access their employee data and, where required, where those requests can originate.

The API returns personal, employment, organisational and reporting-line information together in a consistent JSON structure.

Organisations and integration partners can build connections between Sense HR and other business systems more easily, without needing to stitch together multiple employee data sources.

Changing the workflow configuration or upgrading to a new version of the workflow currently creates a new endpoint and API key.

Make sure any systems using the existing endpoint are updated with the new details following a configuration change or upgrade.

For endpoint details, authentication, filtering options, response fields, request examples and troubleshooting, see:

👉 Employee Core Data API

Retrieve employee records from Sense HR through a single endpoint.

The new Employee Core Data API provides a simpler way to integrate Sense HR employee information with other systems.

A single secure endpoint can return structured personal, employment, organisational and line-manager data, with options to filter the results and restrict access using an API key and optional IP allow-listing.