> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Sage HR

> How to set up the Sage HR connector, plus the actions that are available.

![Sage HR](https://stackone-logos.com/api/sage-hr/filled/svg)

v1.1.0[See changelog](https://docs.stackone.com/connectors/sagehr/changelog.md)

[35 actions](#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](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/sagehr/guides/connector-profile/api-key.md)
>
> Admin access is required to enable API access and generate API keys.

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/sagehr/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

35 actions

ActionDescription

List Employees`sagehr_list_employees`

Retrieve a list of all active employees in the company.

Get Employee`sagehr_get_employee`

Retrieve details of a specific active employee.

Create Employee`sagehr_create_employee`

Create a new employee in the company.

Update Employee`sagehr_update_employee`

Update an existing employee's details.

Get Employee Custom Fields`sagehr_get_employee_custom_fields`

Retrieve custom fields for a specific employee.

Update Employee Custom Field`sagehr_update_employee_custom_field`

Update a custom field value for a specific employee.

Terminate Employee`sagehr_terminate_employee`

Terminate an employee.

Rehire Employee`sagehr_rehire_employee`

Rehire a previously terminated employee.

Get Employee Compensations`sagehr_get_employee_compensations`

Retrieve salary history for a specific employee.

Get Employee Time Off Balances`sagehr_get_employee_time_off_balances`

Retrieve time-off balances for a specific employee.

List Terminated Employees`sagehr_list_terminated_employees`

Retrieve a list of all terminated employees.

Get Terminated Employee`sagehr_get_terminated_employee`

Retrieve details of a specific terminated employee.

List Leave Policies`sagehr_list_leave_policies`

Retrieve a list of all time-off policies.

Get Leave Policy`sagehr_get_leave_policy`

Retrieve details of a specific time-off policy.

List Leave Requests`sagehr_list_leave_requests`

Retrieve a list of all time-off requests.

Create Leave Request`sagehr_create_leave_request`

Create a new time-off request for an employee.

List Employees Out Of Office`sagehr_list_employees_out_of_office`

Retrieve a list of employees who are out of the office.

Get Leave Allowances Report`sagehr_get_leave_allowances_report`

Retrieve individual leave allowances report.

List Document Categories`sagehr_list_document_categories`

Retrieve a list of all document categories.

List Documents`sagehr_list_documents`

Retrieve a list of all documents.

Get Document`sagehr_get_document`

Retrieve details of a specific document.

Create Document`sagehr_create_document`

Upload a new document.

Update Document`sagehr_update_document`

Update an existing document.

Delete Document`sagehr_delete_document`

Delete a document.

List Positions`sagehr_list_positions`

Retrieve a list of all company positions.

List Teams`sagehr_list_teams`

Retrieve a list of all company teams.

List Termination Reasons`sagehr_list_termination_reasons`

Retrieve a list of all termination reasons.

Get Overall Goals Progress`sagehr_get_overall_goals_progress`

Retrieve overall quarterly goals progress.

Get Company Goals Progress`sagehr_get_company_goals_progress`

Retrieve company-level quarterly goals progress.

Get Team Goals Progress`sagehr_get_team_goals_progress`

Retrieve team-level quarterly goals progress.

Get Individual Goals Progress`sagehr_get_individual_goals_progress`

Retrieve individual-level quarterly goals progress.

List Onboarding Categories`sagehr_list_onboarding_categories`

Retrieve a list of all onboarding task categories.

Create Onboarding Task`sagehr_create_onboarding_task`

Create a new onboarding task template.

List Offboarding Categories`sagehr_list_offboarding_categories`

Retrieve a list of all offboarding task categories.

Create Offboarding Task`sagehr_create_offboarding_task`

Create a new offboarding task template.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.