​
Overview

To authenticate with Sage HR, you need:
  1. Subdomain - The subdomain of your Sage HR account (e.g. company.sage.hr)
  2. API Key - A unique key that authenticates API requests to access Sage HR resources and services
This guide will walk you through enabling API access and generating an API key within Sage HR.

​
Prerequisites:

  • You must have a Sage HR account with Admin rights

​
Instructions:

​
Step 1: Enabling API Access

To enable API access and generate an API key:
  1. Log into your Sage HR account
  2. Click on your name in the top right corner
  3. Click Settings
  4. In the settings menu, click INTEGRATIONS, then API
  5. Click ENABLE API ACCESS to activate API access and generate your unique API key

​
Step 2: Enter Credentials in the Connect UI

Once you have enabled API access:
  1. Open the form where you need to authenticate with Sage HR
  2. Enter your Subdomain (the part before .sage.hr in your Sage HR URL)
  3. Enter the API Key that was generated when enabling API access
  4. Submit the form to complete authentication
You are now connected to Sage HR.