Sage HR provides a public Representational State Transfer (REST) API. You can use it to connect Sage HR with other systems and access your data securely.
Each Sage HR company has its own API service. The service supports all public endpoints.
View the API documentation
Use the Sage HR API documentation to explore endpoints and see data examples.
Enable API access
📎NOTE: You need admin permissions to enable API access.
If you do not have admin access, contact the administrator of your Sage HR account to enable API access and provide the key.
Select your name in the top‑right corner.
Select Settings.
Select Integrations, then API.
Select Enable API access.
Sage HR generates a unique API key for your user. To retrieve your API key, navigate to Settings > Integrations > API. The key will be displayed on this page, and you can copy it for use in your integrations. If your account still displays demo data, the API settings may not appear. Use the Start Fresh option at the top of the page to clear demo data. Once cleared, the API settings will become visible under Settings > Integrations.
Authenticate with the API
Sage HR uses an API key for authentication.
You must include the API key in the X‑Auth‑Token header with every request.
⚠CAUTION: Keep your API key secure. Don’t share it with third parties. Use secure channels when sharing it internally.
Manage your API key
Your API key:
Is unique to your user
Doesn’t change unless you disable and re‑enable API access
Grants access to all API‑enabled data for that user
You can’t restrict API access by feature for a key holder.
📎NOTE: If an admin loses admin permissions, Sage HR invalidates their API key.
How can I limit a third-party developer’s access to employee data when I use an API key?
To protect your employees’ personal data, you must manage access yourself.
You should:
Only share API keys with trusted developers
Agree in writing what the developer can do with the data
Define clear consequences if they breach the agreement
Remove or regenerate the API key if you no longer trust the integration
You remain responsible for how the developer uses the API key. A signed agreement helps protect your business and employees.