Get started

Sage HR provides public REST API that can be used to connect to other systems and get all the information at your fingertips.

Your Sage HR company has an individual API service that supports all public endpoints.

API documentation

For the HR API Reference documentation please visit the API Reference.

We also provide an Apiary powered interactive console, where you can browse the endpoints and data samples, test calls and see responses:

Access the Sage HR Interactive console

How to start using Sage HR API

NOTE: Enabling API access requires a user with Admin rights.

To activate API:

1. Click on your name on the top right, then click Settings.
2. On the settings menu, click INTEGRATIONS, then click API.
3. Click ENABLE API ACCESS to activate access to API and provide you with your unique API key.

How to access and authenticate to Sage HR API from an external system

The Sage HR authentication scheme uses an API key (API token). Your API key should be kept a secret. Do not disclose your API key to third parties and use only secure  channels to communicate it within your team.

An API key is a mandatory detail that should be passed in X-Auth-Token header with every request sent to endpoint URL.

Once generated, the API key will not change, but it will always remain unique to your user. However, disabling and enabling your API access again will generate a new API key for every user of your Sage HR account.

NOTE: If an administrator user loses their admin permissions, their API key will be invalidated.