> ## 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.

# BreatheHR

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

![BreatheHR](https://stackone-logos.com/api/breathe/filled/svg)

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

[42 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/breathehr/guides/connector-profile/api-key.md)
>
> Uses an API key from your BreatheHR account, with a separate key for each of Production and Sandbox.

**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/breathehr/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

42 actions

ActionDescription

List Employees`breathehr_list_employees`

Get a list of employees

Get Employee`breathehr_get_employee`

Get a specific employee by ID

List Employee Absences`breathehr_list_employee_absences`

Get absences for a specific employee by ID

List Employee Benefits`breathehr_list_employee_benefits`

Get benefits for a specific employee by ID

List Employee Bonuses`breathehr_list_employee_bonuses`

Get bonuses for a specific employee by ID

List Employee Holiday Years`breathehr_list_employee_holiday_years`

Get holiday years for a specific employee by ID

List Employee Leave Requests`breathehr_list_employee_leave_requests`

Get leave requests for a specific employee by ID

List Employee Salaries`breathehr_list_employee_salaries`

Get salaries for a specific employee by ID

List Employee Sicknesses`breathehr_list_employee_sicknesses`

Get sicknesses for a specific employee by ID

Create Employee Leave Request`breathehr_create_employee_leave_request`

Create a leave request for a specific employee

Create Employee Sickness`breathehr_create_employee_sickness`

Create a sickness record for a specific employee

Create Employee`breathehr_create_employee`

Create a new employee

List Holiday Allowances`breathehr_list_holiday_allowances`

Get a list of holiday allowances

List Statutory Holiday Countries`breathehr_list_statutory_holiday_countries`

Get a list of statutory holiday countries

List Leave Requests`breathehr_list_leave_requests`

Get a list of leave requests

Get Leave Request`breathehr_get_leave_request`

Get a specific leave request by ID

Approve Leave Request`breathehr_approve_leave_request`

Approve a specific leave request by ID

Get Leave Request Cancelling`breathehr_get_leave_request_cancelling`

Find the request this leave request is cancelling

Reject Leave Request`breathehr_reject_leave_request`

Reject a specific leave request by ID

List Other Leave Reasons`breathehr_list_other_leave_reasons`

Get a list of other leave reasons

List Locations`breathehr_list_locations`

Get a list of locations

List Salaries`breathehr_list_salaries`

Get a list of salaries

List Sicknesses`breathehr_list_sicknesses`

Get a list of sicknesses

Update Sickness`breathehr_update_sickness`

Update a specific sickness record by ID

Delete Sickness`breathehr_delete_sickness`

Delete a specific sickness record by ID

List Working Patterns`breathehr_list_working_patterns`

Get a list of working patterns

List Absences`breathehr_list_absences`

Get a list of absences

Cancel Absence`breathehr_cancel_absence`

Cancel a specific absence by ID

Get Account Details`breathehr_get_account`

Get account details

List Benefits`breathehr_list_benefits`

Get a list of benefits

List Bonuses`breathehr_list_bonuses`

Get a list of bonuses

List Company Documents`breathehr_list_company_documents`

Get a list of company documents

List Company Projects`breathehr_list_company_projects`

Get a list of company projects

Get Company Project`breathehr_get_company_project`

Get a specific company project by ID

List Departments`breathehr_list_departments`

Get a list of departments

List Department Absences`breathehr_list_department_absences`

Get absences for a specific department by ID

List Department Benefits`breathehr_list_department_benefits`

Get benefits for a specific department by ID

List Department Bonuses`breathehr_list_department_bonuses`

Get bonuses for a specific department by ID

List Department Leave Requests`breathehr_list_department_leave_requests`

Get leave requests for a specific department by ID

List Department Salaries`breathehr_list_department_salaries`

Get salaries for a specific department by ID

List Divisions`breathehr_list_divisions`

Get a list of divisions

List Employee Jobs`breathehr_list_employee_jobs`

Get a list of employee jobs


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