Skip to main content

Integration Specifications

Prerequisites

Getting an API key and workspace key

  1. After logging in to Sage HR, click the account menu at the top right, then select Settings. For details, see Sage HR API (external site). Sage HR account menu with Settings selected
  2. In the settings screen, expand Integrations in the left menu, then select API.
    API selected under Integrations in the settings left menu
  3. Click Enable API access. Enable API access button shown while the API is disabled
  4. Once the API is enabled, Your API key is issued. Copy and save the value shown. API key issued and shown in the input field
  5. In the URL shown in your browser’s address bar, the part before .sage.hr is your workspace key. Note it down as well. Part of the browser address bar URL showing the workspace key

Setting up the integration

  1. On the integration screen, search for Sage HR.
  2. Enter the following, then click Integrate:
    • Workspace Name (optional): any name you like
    • Workspace key: the workspace key from step 5
    • API Key: the API key from step 4
    Sage HR integration setup screen with workspace key and API key fields
  3. Once the integration with Sage HR succeeds, registered user information appears in the account list. If it doesn’t complete successfully, first try the steps in Troubleshooting failed SaaS integrations. If that doesn’t resolve it, check Information to provide and contact support.
Last modified on September 13, 2026