Skip to main content
Sage HR
v1.0.2
35 actions · 1 auth method
HRIS

​
Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See Organizations & Projects.
2

Configure the Connector

Enable the connector and set up a Connector Profile in your project. See Setup Connector Profile.

Connector Profile · API Key

Admin access is required to enable API access and generate API keys.
3

Link an Account

Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

Link Account · API Key

4

Use Actions

Connect your agent to the linked account’s actions. See Agent Setup.Other ways to call actions are listed in Protocols & SDKs.

​
Actions

35 actions
Action
Description
List Employees
Retrieve a list of all active employees in the company.
Get Employee
Retrieve details of a specific active employee.
Create Employee
Create a new employee in the company.
Update Employee
Update an existing employee’s details.
Get Employee Custom Fields
Retrieve custom fields for a specific employee.
Update Employee Custom Field
Update a custom field value for a specific employee.
Terminate Employee
Terminate an employee.
Rehire Employee
Rehire a previously terminated employee.
Get Employee Compensations
Retrieve salary history for a specific employee.
Get Employee Time Off Balances
Retrieve time-off balances for a specific employee.
List Terminated Employees
Retrieve a list of all terminated employees.
Get Terminated Employee
Retrieve details of a specific terminated employee.
List Leave Policies
Retrieve a list of all time-off policies.
Get Leave Policy
Retrieve details of a specific time-off policy.
List Leave Requests
Retrieve a list of all time-off requests.
Create Leave Request
Create a new time-off request for an employee.
List Employees Out Of Office
Retrieve a list of employees who are out of the office.
Get Leave Allowances Report
Retrieve individual leave allowances report.
List Document Categories
Retrieve a list of all document categories.
List Documents
Retrieve a list of all documents.
Get Document
Retrieve details of a specific document.
Create Document
Upload a new document.
Update Document
Update an existing document.
Delete Document
Delete a document.
List Positions
Retrieve a list of all company positions.
List Teams
Retrieve a list of all company teams.
List Termination Reasons
Retrieve a list of all termination reasons.
Get Overall Goals Progress
Retrieve overall quarterly goals progress.
Get Company Goals Progress
Retrieve company-level quarterly goals progress.
Get Team Goals Progress
Retrieve team-level quarterly goals progress.
Get Individual Goals Progress
Retrieve individual-level quarterly goals progress.
List Onboarding Categories
Retrieve a list of all onboarding task categories.
Create Onboarding Task
Create a new onboarding task template.
List Offboarding Categories
Retrieve a list of all offboarding task categories.
Create Offboarding Task
Create a new offboarding task template.