> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Breathe HR

> BreatheHR is a simple, cloud-based HR software designed for SMEs to manage employee records, absences, performance reviews, and other HR processes.

![Breathe HR logo](https://mintcdn.com/composio-preview/PudKL42NVsy5O-ND/images/toolkits/breathehr.svg?fit=max\&auto=format\&n=PudKL42NVsy5O-ND\&q=85\&s=493b18c44ee6526964c9eebefbc5ec5b)

* **Category:** human resources
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 50
* **Triggers:** 0
* **Slug:** `BREATHEHR`
* **Version:** 20261101\_00

## Tools

> [accordion] Approve Leave Request
>
> **Slug:** `BREATHEHR_APPROVE_LEAVE_REQUEST`
>
> Submit an approval for a BreatheHR leave request by ID. Use this when an authorized user needs to approve a pending leave request.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> ID of the leave request to approve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Employee
>
> **Slug:** `BREATHEHR_CREATE_EMPLOYEE`
>
> Tool to create a new employee in BreatheHR. Use when you need to add a new employee record with their personal information, contact details, and employment information. Required fields are first\_name, last\_name, email, and company\_join\_date.
>
> #### Input Parameters
>
> **hr** `boolean`
>
> Whether the employee has HR manager permissions
>
> **ddi** `string`
>
> Direct dial-in number for the employee
>
> **dob** `string`
>
> Employee's date of birth in YYYY-MM-DD format
>
> **email** `string` *required*
>
> Employee's work email address
>
> **gender** `string`
>
> Employee's gender identifier
>
> **salary** `object`
>
> Salary information
>
> **status** `string ("Current employee" | "Pending leaver" | "Ex-employee")`
>
> Employee status enum
>
> **division** `integer`
>
> Division ID the employee belongs to
>
> **location** `integer`
>
> Location ID where the employee is based
>
> **work\_ext** `string`
>
> Work extension number
>
> **ethnicity** `string`
>
> Employee's ethnicity
>
> **job\_title** `string`
>
> Employee's job title or position
>
> **last\_name** `string` *required*
>
> Employee's last name
>
> **department** `integer`
>
> Department ID the employee belongs to
>
> **first\_name** `string` *required*
>
> Employee's first name
>
> **middle\_name** `string`
>
> Employee's middle name
>
> **nationality** `string ("British" | "Afghan" | "Albanian" | "Algerian" | "Andorran" | "Angolan" | "Antiguans" | "Argentinean" | "Armenian" | "Australian" | "Austrian" | "Azerbaijani" | "Bahamian" | "Bahraini" | "Bangladeshi" | "Barbadian" | "Barbudans" | "Belarusian" | "Belgian" | "Belizean" | "Beninese" | "Bermudian" | "Bhutanese" | "Bolivian" | "Bosnian" | "Botswana" | "Brazilian" | "Bruneian" | "Bulgarian" | "Burkinabe" | "Burmese" | "Burundian" | "Cambodian" | "Cameroonian" | "Canadian" | "Cape Verdean" | "Caymanian" | "Central African" | "Chadian" | "Chilean" | "Chinese" | "Colombian" | "Comoran" | "Congolese" | "Cornish British" | "Costa Rican" | "Croatian" | "Cuban" | "Cypriot" | "Czech" | "Danish" | "Djibouti" | "Dominican" | "Dutch" | "East Timorese" | "Ecuadorean" | "Egyptian" | "Emirian" | "English" | "Equatorial Guinean" | "Eritrean" | "Estonian" | "Ethiopian" | "Fijian" | "Filipino" | "Finnish" | "French" | "Gabonese" | "Gambian" | "Georgian" | "German" | "Ghanaian" | "Greek" | "Grenadian" | "Guatemalan" | "Guinea-Bissauan" | "Guinean" | "Guyanese" | "Haitian" | "Herzegovinian" | "Honduran" | "Hongkonger" | "Hungarian" | "Icelander" | "Indian" | "Indonesian" | "Iranian" | "Iraqi" | "Irish" | "Israeli" | "Italian" | "Ivorian" | "Jamaican" | "Japanese" | "Jordanian" | "Kazakhstani" | "Kenyan" | "Kittian and Nevisian" | "Kuwaiti" | "Kyrgyz" | "Laotian" | "Latvian" | "Lebanese" | "Liberian" | "Libyan" | "Liechtensteiner" | "Lithuanian" | "Luxembourger" | "Macedonian" | "Malagasy" | "Malawian" | "Malaysian" | "Maldivan" | "Malian" | "Maltese" | "Marshallese" | "Mauritanian" | "Mauritian" | "Mexican" | "Micronesian" | "Moldovan" | "Monacan" | "Mongolian" | "Montenegrin" | "Moroccan" | "Mosotho" | "Motswana" | "Mozambican" | "Namibian" | "Nauruan" | "Nepalese" | "Netherlander" | "New Zealander" | "Ni-Vanuatu" | "Nicaraguan" | "Nigerian" | "Nigerien" | "North Korean" | "Northern Irish" | "Norwegian" | "Omani" | "Pakistani" | "Palauan" | "Palestinian" | "Panamanian" | "Papua New Guinean" | "Paraguayan" | "Peruvian" | "Polish" | "Portuguese" | "Qatari" | "Romanian" | "Russian" | "Rwandan" | "Saint Lucian" | "Salvadoran" | "Samoan" | "San Marinese" | "Sao Tomean" | "Saudi" | "Scottish" | "Senegalese" | "Serbian" | "Seychellois" | "Sierra Leonean" | "Singaporean" | "Slovakian" | "Slovenian" | "Solomon Islander" | "Somali" | "South African" | "South Korean" | "Spanish" | "Sri Lankan" | "Sudanese" | "Surinamer" | "Swazi" | "Swedish" | "Swiss" | "Syrian" | "Taiwanese" | "Tajik" | "Tanzanian" | "Thai" | "Togolese" | "Tongan" | "Trinidadian or Tobagonian" | "Tunisian" | "Turkish" | "Tuvaluan" | "Ugandan" | "Ukrainian" | "Uruguayan" | "USA" | "Uzbekistani" | "Venezuelan" | "Vietnamese" | "Vincentian" | "Welsh" | "Yemeni" | "Zambian" | "Zimbabwean")`
>
> Nationality enum with all supported values
>
> **person\_type** `string ("Employee" | "Contractor" | "Volunteer")`
>
> Person type enum
>
> **work\_mobile** `string`
>
> Employee's work mobile phone number
>
> **employee\_ref** `string`
>
> Employee reference number or employee ID
>
> **ethnicity\_id** `string`
>
> Ethnicity identifier
>
> **home\_telephone** `string`
>
> Employee's home telephone number
>
> **job\_start\_date** `string`
>
> Date employee started their current job role in YYYY-MM-DD format
>
> **marital\_status** `string ("Single" | "Co-Habiting" | "Married" | "Civil Partnership" | "Separated" | "Divorced" | "Widowed")`
>
> Marital status enum
>
> **personal\_mobile** `string`
>
> Employee's personal mobile phone number
>
> **working\_pattern** `integer`
>
> Working pattern ID defining the employee's work schedule
>
> **company\_join\_date** `string` *required*
>
> Date employee joined the company in YYYY-MM-DD format
>
> **full\_or\_part\_time** `string ("Full-Time" | "Part-Time")`
>
> Employment type enum
>
> **holiday\_allowance** `integer`
>
> Holiday allowance ID defining the employee's leave entitlement
>
> **working\_pattern\_id** `integer`
>
> Alternative field for working pattern ID
>
> **holiday\_allowance\_id** `integer`
>
> Alternative field for holiday allowance ID
>
> **national\_insurance\_no** `string`
>
> UK National Insurance Number
>
> **ignore\_working\_pattern** `boolean`
>
> If true, ignores working pattern and allows manual entry of time lost when requesting leave
>
> **statutory\_holiday\_country** `string`
>
> Name of the country for statutory holidays
>
> **receives\_statutory\_holidays** `boolean`
>
> Whether the employee receives statutory holidays for their country
>
> **statutory\_holiday\_country\_id** `integer`
>
> ID of the country for statutory holidays
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Employee Change Request
>
> **Slug:** `BREATHEHR_CREATE_EMPLOYEE_CHANGE_REQUEST`
>
> Tool to create a change request for an employee field. Use when you need to update employee information such as job title, department, or salary.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The employee ID for whom the change request is being created.
>
> **field** `string` *required*
>
> The field name to change (e.g., 'job\_title', 'department', 'salary').
>
> **value** `string` *required*
>
> The new value for the field.
>
> **approved** `boolean`
>
> Set to true to immediately apply the change without approval workflow. If false or omitted, the change requires approval.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Employee Expense
>
> **Slug:** `BREATHEHR_CREATE_EMPLOYEE_EXPENSE`
>
> Create an employee expense record in BreatheHR for reimbursement or to record a company-paid expense.
>
> #### Input Parameters
>
> **vat** `integer`
>
> The VAT (Value Added Tax) amount included in the expense, in the smallest currency unit (e.g., cents). Optional for jurisdictions using VAT.
>
> **miles** `integer`
>
> The number of miles traveled if this is a mileage expense. Use together with company\_mileage\_rate\_id for travel reimbursement.
>
> **amount** `integer` *required*
>
> The expense amount in the smallest currency unit (e.g., cents for USD, pence for GBP). For example, 5000 represents \$50.00 or £50.00.
>
> **client\_name** `string`
>
> The name of the client if the expense is chargeable to a client. Required if chargeable\_to\_client is true.
>
> **description** `string` *required*
>
> A textual description of the expense (e.g., 'Office supplies purchase', 'Client meeting lunch').
>
> **employee\_id** `integer` *required*
>
> The unique identifier of the employee who incurred the expense.
>
> **has\_receipt** `boolean`
>
> Whether a receipt exists for this expense. Set to true if the employee has provided a receipt that can be uploaded separately.
>
> **expense\_date** `string` *required*
>
> The date the expense was incurred, in YYYY-MM-DD format.
>
> **company\_project\_id** `integer`
>
> The identifier for the company project this expense relates to, if applicable. Use to track expenses by project.
>
> **payable\_to\_employee** `boolean` *required*
>
> Whether the expense amount should be reimbursed/paid to the employee (true) or was paid by the company directly (false).
>
> **chargeable\_to\_client** `boolean`
>
> Whether this expense should be charged/billed to a client. Set to true if the expense is billable to a client project.
>
> **company\_expense\_type\_id** `integer` *required*
>
> The identifier for the expense type/category as defined in the company's expense configuration.
>
> **company\_mileage\_rate\_id** `integer`
>
> The identifier for the mileage reimbursement rate if this is a mileage expense. Use this for travel expenses calculated by distance.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Employee Expense Claim
>
> **Slug:** `BREATHEHR_CREATE_EMPLOYEE_EXPENSE_CLAIM`
>
> Tool to create a new expense claim for an employee. Use when you need to submit expenses for reimbursement by grouping one or more unclaimed expense records into a claim.
>
> #### Input Parameters
>
> **employee\_id** `integer` *required*
>
> The ID of the employee for whom the expense claim is being created
>
> **employee\_expense\_ids** `array` *required*
>
> Array of employee expense IDs to include in the claim. Must reference unclaimed expenses (expenses where employee\_expense\_claim\_id is null).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Employee Sickness
>
> **Slug:** `BREATHEHR_CREATE_EMPLOYEE_SICKNESS`
>
> Tool to create a sickness record for an employee in BreatheHR. Use when you need to log an employee's sick leave with details like type, dates, and status.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> The unique identifier of the employee to create sickness for
>
> **reason** `string`
>
> Reason for the sickness
>
> **status** `string ("open" | "returned" | "rejected" | "clarification" | "closed")`
>
> Enum for sickness status values.
>
> **end\_date** `string`
>
> End date of the sickness in YYYY-MM-DD format
>
> **half\_day** `boolean`
>
> Whether this is a half day sickness
>
> **half\_end** `boolean`
>
> Whether the end date is a half day
>
> **half\_start** `boolean`
>
> Whether the start date is a half day
>
> **start\_date** `string` *required*
>
> Start date of the sickness in YYYY-MM-DD format (required)
>
> **review\_notes** `string`
>
> Review notes for the sickness record
>
> **half\_end\_am\_pm** `string ("am" | "pm")`
>
> Enum for half day period values.
>
> **half\_start\_am\_pm** `string ("am" | "pm")`
>
> Enum for half day period values.
>
> **company\_sicknesstype\_id** `integer` *required*
>
> The ID of the company sickness type (required)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Employee Expense
>
> **Slug:** `BREATHEHR_DELETE_EMPLOYEE_EXPENSE`
>
> Tool to delete an employee expense by ID. Use when you need to remove an expense record from the system.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> The unique identifier of the employee expense to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Employee Training Course
>
> **Slug:** `BREATHEHR_DELETE_EMPLOYEE_TRAINING_COURSE`
>
> Tool to delete an employee training course record by its ID. Use when you need to remove a training record from an employee's profile.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique identifier of the employee training course record to delete
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Account
>
> **Slug:** `BREATHEHR_GET_ACCOUNT`
>
> Tool to retrieve account information including ID, name, domain, UUID, and RTA usage status. Use when you need to check account details or verify account configuration.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Employee
>
> **Slug:** `BREATHEHR_GET_EMPLOYEE`
>
> Tool to retrieve detailed information about a specific employee by ID. Use when you need comprehensive employee data including personal details, employment information, organizational structure, and compensation.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> The unique identifier of the employee to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Employee Expense
>
> **Slug:** `BREATHEHR_GET_EMPLOYEE_EXPENSE`
>
> Tool to retrieve a specific employee expense record by ID. Use when you need detailed information about a particular expense.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> Employee expense record ID to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Leave Request
>
> **Slug:** `BREATHEHR_GET_LEAVE_REQUEST`
>
> Tool to retrieve detailed information about a specific leave request by ID. Use when you need to check the status, dates, or details of a particular leave/absence request.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> The unique identifier of the leave request to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Leave Request Cancelling
>
> **Slug:** `BREATHEHR_GET_LEAVE_REQUEST_CANCELLING`
>
> Tool to retrieve the leave request that is being cancelled. Use when you need to find the original leave request associated with a cancellation request.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> The unique identifier of the leave request to get cancelling information for
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Absences
>
> **Slug:** `BREATHEHR_LIST_ABSENCES`
>
> Tool to list all absences with optional filtering by date range, employee, department, and type. Use when you need to retrieve absence records from BreatheHR with pagination support.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page of results to fetch. Defaults to 1.
>
> **type** `string ("Holiday" | "OtherLeave")`
>
> Type of absences to return. Use 'Holiday' for holidays or 'OtherLeave' for other leave types.
>
> **end\_date** `string`
>
> Return absences on or before this date. Format: YYYY-MM-DD.
>
> **per\_page** `integer`
>
> Number of results to return per page. Useful for pagination.
>
> **rotacloud** `boolean`
>
> Return absences where rotacloud is not excluded from integration.
>
> **start\_date** `string`
>
> Return absences on or after this date. Format: YYYY-MM-DD.
>
> **employee\_id** `integer`
>
> Return absences for this employee only. Alternative to using /employees/:id/absences endpoint.
>
> **department\_id** `integer`
>
> Return absences for this department only. Alternative to using /departments/:id/absences endpoint.
>
> **other\_leave\_reason\_id** `integer`
>
> ID of other leave reason to filter by. Used to filter absences by specific leave reason.
>
> **exclude\_cancelled\_absences** `boolean`
>
> When set to true, cancelled absences will not be returned in the results.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Employee Benefits
>
> **Slug:** `BREATHEHR_LIST_BENEFITS`
>
> Tool to retrieve a list of employee benefits with optional pagination. Use when you need to access benefit information across employees.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page of results to fetch. Defaults to 1 if not specified.
>
> **per\_page** `integer`
>
> Number of results to return per page. If not specified, uses API default.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Employee Bonuses
>
> **Slug:** `BREATHEHR_LIST_BONUSES`
>
> Tool to retrieve employee bonuses from BreatheHR with pagination support. Use when you need to list bonuses across the organization.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page of results to fetch. Must be a positive integer.
>
> **per\_page** `integer`
>
> Number of results to return per page. Must be a positive integer.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Change Requests
>
> **Slug:** `BREATHEHR_LIST_CHANGE_REQUESTS`
>
> Tool to list change requests from BreatheHR. Use when you need to retrieve change requests with optional pagination.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page of results to fetch.
>
> **per\_page** `integer`
>
> Number of results to return per page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Company Documents
>
> **Slug:** `BREATHEHR_LIST_COMPANY_DOCUMENTS`
>
> Tool to retrieve a paginated list of company documents from BreatheHR. Use when you need to access or view company-wide documents stored in the BreatheHR system.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number of results to fetch. Defaults to 1 for the first page.
>
> **per\_page** `integer`
>
> Number of results to return per page. If not specified, the API will use its default page size.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Company Projects
>
> **Slug:** `BREATHEHR_LIST_COMPANY_PROJECTS`
>
> Tool to list company projects from BreatheHR. Use when you need to retrieve all projects associated with the company. Supports pagination via page and per\_page parameters.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number of results to fetch. Must be a positive integer.
>
> **per\_page** `integer`
>
> Number of results to return per page. Must be a positive integer if specified.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Company Training Types
>
> **Slug:** `BREATHEHR_LIST_COMPANY_TRAINING_TYPES`
>
> Tool to list company training types. Use when you need to retrieve available training type categories. Returns paginated training type records including identifiers, names, and timestamps.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page of results to fetch.
>
> **per\_page** `integer`
>
> Number of results to return per page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Department Absences
>
> **Slug:** `BREATHEHR_LIST_DEPARTMENT_ABSENCES`
>
> Tool to list absences for a specific department. Use when you need to retrieve absence records for employees in a department. Supports pagination and filtering of cancelled absences.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> ID of department to return absences for
>
> **page** `integer`
>
> Page of results to fetch. Default is 1.
>
> **per\_page** `integer`
>
> Number of results to return per page. Default is 50, maximum is 100.
>
> **exclude\_cancelled\_absences** `boolean`
>
> Don't return cancelled leave requests. Set to true to exclude cancelled absences.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Department Benefits
>
> **Slug:** `BREATHEHR_LIST_DEPARTMENT_BENEFITS`
>
> Tool to list all employee benefits for a specific department. Use when you need to retrieve benefit information including contributions, dates, and provider details for department members.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Unique identifier of the department to retrieve benefits for.
>
> **page** `integer`
>
> Page number of results to fetch. Defaults to 1.
>
> **per\_page** `integer`
>
> Number of results to return per page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Department Bonuses
>
> **Slug:** `BREATHEHR_LIST_DEPARTMENT_BONUSES`
>
> Tool to list bonuses for a specific department. Use when you need to retrieve bonus information for employees within a department. Returns paginated bonus records including amounts, award dates, and descriptions.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique identifier of the department to retrieve bonuses for.
>
> **page** `integer`
>
> Page of results to fetch.
>
> **per\_page** `integer`
>
> Number of results to return per page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Department Leave Requests
>
> **Slug:** `BREATHEHR_LIST_DEPARTMENT_LEAVE_REQUESTS`
>
> Tool to list leave requests for a specific department. Use when you need to retrieve absence or time-off requests for employees within a particular department.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> ID of department to return leave requests for
>
> **page** `integer`
>
> Page of results to fetch. Defaults to 1.
>
> **per\_page** `integer`
>
> Number of results to return per page. Controls pagination size.
>
> **exclude\_cancelled\_requests** `boolean`
>
> Don't return cancelled leave requests. Set to true to exclude cancelled requests from the results.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Departments
>
> **Slug:** `BREATHEHR_LIST_DEPARTMENTS`
>
> Tool to list all company departments from BreatheHR. Use when you need to retrieve department information including IDs and names. Returns a paginated list of departments.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page of results to fetch.
>
> **per\_page** `integer`
>
> Number of results to return per page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Department Salaries
>
> **Slug:** `BREATHEHR_LIST_DEPARTMENT_SALARIES`
>
> Tool to list salaries for a specific department. Use when you need to retrieve salary information for employees within a department. Returns paginated salary records including amounts, dates, and basis information.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique identifier of the department to retrieve salaries for.
>
> **page** `integer`
>
> Page of results to fetch.
>
> **per\_page** `integer`
>
> Number of results to return per page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Divisions
>
> **Slug:** `BREATHEHR_LIST_DIVISIONS`
>
> Tool to retrieve all company divisions. Use when you need to view organizational divisions or departments.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Employee Absences
>
> **Slug:** `BREATHEHR_LIST_EMPLOYEE_ABSENCES`
>
> Tool to list absences for a specific employee from BreatheHR. Use when you need to retrieve absence records for an employee with optional filtering and pagination.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> ID of employee to return absences for
>
> **page** `integer`
>
> Page of results to fetch.
>
> **per\_page** `integer`
>
> Number of results to return per page.
>
> **exclude\_cancelled\_absences** `boolean`
>
> Don't return cancelled leave requests
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Employee Benefits
>
> **Slug:** `BREATHEHR_LIST_EMPLOYEE_BENEFITS`
>
> List benefits for a specific employee by ID, with pagination.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The employee ID to retrieve benefits for
>
> **page** `integer`
>
> Page of results to fetch.
>
> **per\_page** `integer`
>
> Number of results to return per page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Employee Bonuses
>
> **Slug:** `BREATHEHR_LIST_EMPLOYEE_BONUSES`
>
> List bonuses for a specific employee by ID, with pagination.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Employee ID to fetch bonuses for
>
> **page** `integer`
>
> Page of results to fetch.
>
> **per\_page** `integer`
>
> Number of results to return per page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Employee Change Requests
>
> **Slug:** `BREATHEHR_LIST_EMPLOYEE_CHANGE_REQUESTS`
>
> Tool to list change requests for a specific employee. Use when you need to retrieve pending or historical change requests associated with an employee.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The employee ID to fetch change requests for
>
> **page** `integer`
>
> Page of results to fetch
>
> **per\_page** `integer`
>
> Number of results to return per page
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Employee Expense Claims
>
> **Slug:** `BREATHEHR_LIST_EMPLOYEE_EXPENSE_CLAIMS`
>
> Tool to list employee expense claims from BreatheHR. Use when you need to retrieve expense claims, optionally filtered by employee ID or claim state. Supports pagination for large result sets.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page of results to fetch. Defaults to 1.
>
> **per\_page** `integer`
>
> Number of results to return per page. If not specified, the API will use its default page size.
>
> **employee\_id** `integer`
>
> Return expense claims for this employee only. If not provided, returns expense claims for all employees.
>
> **state\_filter** `string ("submitted" | "approved" | "completed" | "rejected")`
>
> Filter expense claims by their current state. Only claims matching this state will be returned.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Employee Expenses
>
> **Slug:** `BREATHEHR_LIST_EMPLOYEE_EXPENSES`
>
> Tool to list employee expenses from BreatheHR. Use when you need to retrieve expense records, optionally filtered by employee or claim status.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number of results to fetch. Defaults to 1 if not specified.
>
> **per\_page** `integer`
>
> Number of results to return per page. If not specified, the API default applies.
>
> **employee\_id** `integer`
>
> Return expenses for this employee only. If not specified, returns expenses for all employees.
>
> **show\_claimed** `boolean`
>
> Include claimed expenses in search. If not specified, the API default behavior applies.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Employee Holiday Years
>
> **Slug:** `BREATHEHR_LIST_EMPLOYEE_HOLIDAY_YEARS`
>
> Tool to get holiday years for an employee. Use when you need to retrieve holiday allowance information for a specific employee, optionally filtered by date.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> ID of employee to return holiday years for
>
> **for\_date** `string`
>
> Return employee\_holiday\_years that include this date. Format: YYYY-MM-DD
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Employee Jobs
>
> **Slug:** `BREATHEHR_LIST_EMPLOYEE_JOBS`
>
> Tool to list employee jobs with optional employee filtering. Use when you need to retrieve job information for employees. Returns paginated job records including title, employment type, dates, and timestamps.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page of results to fetch.
>
> **per\_page** `integer`
>
> Number of results to return per page.
>
> **employee\_id** `integer`
>
> Return jobs for this employee only. If not provided, returns jobs for all employees.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Employee Leave Requests
>
> **Slug:** `BREATHEHR_LIST_EMPLOYEE_LEAVE_REQUESTS`
>
> Tool to list leave requests for a specific employee. Use when you need to retrieve leave request history including vacation, sick leave, and other absence requests.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> ID of the employee to return leave requests for
>
> **page** `integer`
>
> Page of results to fetch. Defaults to 1.
>
> **per\_page** `integer`
>
> Number of results to return per page. Maximum is 100, default is 25.
>
> **exclude\_cancelled\_requests** `boolean`
>
> Don't return cancelled leave requests when set to true
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Employees
>
> **Slug:** `BREATHEHR_LIST_EMPLOYEES`
>
> List employees in the BreatheHR account with pagination and optional role-type and RotaCloud filters. Pagination metadata from the API's Link and Total headers is returned in the response fields.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page of results to fetch. Defaults to 1.
>
> **filter** `string ("hr" | "line_manager" | "either" | "neither")`
>
> Filter employees by their role type.
>
> **per\_page** `integer`
>
> Number of results to return per page. Maximum is 100, default is 25.
>
> **rotacloud** `boolean`
>
> Return only employees where rotacloud integration is not excluded. When true, filters to employees included in RotaCloud integration.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Employee Salaries
>
> **Slug:** `BREATHEHR_LIST_EMPLOYEE_SALARIES`
>
> Tool to list salaries for a specific employee. Use when you need to retrieve salary history or current salary information for an employee.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique identifier of the employee whose salaries to retrieve.
>
> **page** `integer`
>
> Page of results to fetch.
>
> **per\_page** `integer`
>
> Number of results to return per page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Employee Training Courses
>
> **Slug:** `BREATHEHR_LIST_EMPLOYEE_TRAINING_COURSES`
>
> Tool to list employee training courses with optional filtering by employee and pagination support. Use when you need to retrieve training course records for employees.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page of results to fetch.
>
> **per\_page** `integer`
>
> Number of results to return per page.
>
> **employee\_id** `integer`
>
> Return training courses for this employee only. If not provided, returns courses for all employees.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Holiday Allowances
>
> **Slug:** `BREATHEHR_LIST_HOLIDAY_ALLOWANCES`
>
> Tool to list holiday allowances configured for the company. Returns tiered holiday allowances based on years of service (1-10 years). Use when you need to view or retrieve holiday entitlement configurations.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Leave Requests
>
> **Slug:** `BREATHEHR_LIST_LEAVE_REQUESTS`
>
> Tool to list all leave requests with optional date and employee/department filtering. Use when you need to retrieve absence or time-off requests across the organization, optionally filtered by date range, employee, or department.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page of results to fetch. Defaults to 1.
>
> **end\_date** `string`
>
> Return leave requests starting on or before this date (YYYY-MM-DD format)
>
> **per\_page** `integer`
>
> Number of results to return per page. Controls pagination size.
>
> **rotacloud** `boolean`
>
> Return leave requests where rotacloud is not excluded from integration. When true, filters to leave requests included in RotaCloud integration.
>
> **start\_date** `string`
>
> Return leave requests starting on or after this date (YYYY-MM-DD format)
>
> **employee\_id** `integer`
>
> Return leave requests for this employee only
>
> **department\_id** `integer`
>
> Return leave requests for this department only
>
> **exclude\_cancelled\_requests** `boolean`
>
> Don't return cancelled leave requests. Set to true to exclude cancelled requests from the results.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Locations
>
> **Slug:** `BREATHEHR_LIST_LOCATIONS`
>
> Tool to list all company locations from BreatheHR. Use when you need to retrieve location information including IDs and names. Returns a paginated list of locations.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page of results to fetch.
>
> **per\_page** `integer`
>
> Number of results to return per page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Other Leave Reasons
>
> **Slug:** `BREATHEHR_LIST_OTHER_LEAVE_REASONS`
>
> Tool to list other leave reasons configured for the company in BreatheHR. Use when you need to retrieve available custom leave types beyond standard leave.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Salaries
>
> **Slug:** `BREATHEHR_LIST_SALARIES`
>
> Tool to list employee salaries with pagination support. Use when you need to retrieve salary information across the organization. Returns paginated salary records including amounts, dates, and basis information.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page of results to fetch.
>
> **per\_page** `integer`
>
> Number of results to return per page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Sicknesses
>
> **Slug:** `BREATHEHR_LIST_SICKNESSES`
>
> List a page of BreatheHR sickness absence records, with optional filters for employee, department, date range, and RotaCloud integration status. Pagination metadata is returned when available.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page of results to fetch.
>
> **end\_date** `string`
>
> Return sicknesses starting on or before this date in YYYY-MM-DD format
>
> **per\_page** `integer`
>
> Number of results to return per page.
>
> **rotacloud** `boolean`
>
> Return sicknesses for employees without exclude from rotacloud. When true, filters to employees included in RotaCloud integration.
>
> **start\_date** `string`
>
> Return sicknesses starting on or after this date in YYYY-MM-DD format
>
> **employee\_id** `integer`
>
> Return sicknesses for this employee only
>
> **department\_id** `integer`
>
> Return sicknesses for this department only
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Working Patterns
>
> **Slug:** `BREATHEHR_LIST_WORKING_PATTERNS`
>
> List BreatheHR working patterns with pagination support. Results can include weekly schedules, hours per day, default status, and day-by-day breakdowns.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page of results to fetch. Defaults to 1.
>
> **per\_page** `integer`
>
> Number of results to return per page. Maximum is 100, default is 25.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Reject Leave Request
>
> **Slug:** `BREATHEHR_REJECT_LEAVE_REQUEST`
>
> Tool to reject a leave request in BreatheHR. Use when an authorized user needs to decline an employee's time-off request with a provided reason.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> ID of the leave request to reject
>
> **rejection\_reason** `string` *required*
>
> Reason for rejecting the leave request. This will be communicated to the employee.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Employee Expense Claim
>
> **Slug:** `BREATHEHR_UPDATE_EMPLOYEE_EXPENSE_CLAIM`
>
> Tool to approve or reject an employee expense claim. Use when you need to update the approval status of an expense claim by providing the claim ID and approver/rejector ID.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> The unique identifier of the employee expense claim to update.
>
> **approve** `boolean` *required*
>
> Whether to approve (true) or reject (false) the expense claim.
>
> **rejection\_reason** `string`
>
> Reason for rejecting the expense claim. Required when approve is false.
>
> **approver\_rejector\_id** `integer` *required*
>
> The unique identifier of the employee who is approving or rejecting the claim.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update employee training course
>
> **Slug:** `BREATHEHR_UPDATE_EMPLOYEE_TRAINING_COURSE`
>
> Tool to update an existing employee training course record in BreatheHR. Use when you need to modify training details such as status, dates, notes, outcome, or other training attributes.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique identifier of the employee training course to update. This is required to identify which training record to modify.
>
> **cost** `string`
>
> The cost of the training course as a float string.
>
> **name** `string`
>
> The name or title of the training course.
>
> **notes** `string`
>
> Additional notes or comments about the training course.
>
> **end\_on** `string`
>
> The end date of the training course in date format (YYYY-MM-DD).
>
> **status** `string ("Requested" | "Approved" | "Pending" | "Rejected" | "Booked" | "Completed" | "Cancelled" | "Non-attended" | "Expired")`
>
> Status values for employee training courses.
>
> **outcome** `string ("Passed" | "passed" | "Failed" | "failed")`
>
> Outcome values for completed training courses.
>
> **half\_day** `boolean`
>
> Whether the training is a half-day course (true) or full-day (false).
>
> **start\_on** `string`
>
> The start date of the training course in date format (YYYY-MM-DD).
>
> **followup\_date** `string`
>
> The date for following up on the training in date format (YYYY-MM-DD).
>
> **half\_day\_am\_pm** `string ("am" | "pm")`
>
> Period for half-day training courses.
>
> **company\_training\_type\_id** `integer`
>
> The ID of the training type classification.
>
> **remuneration\_currency\_id** `integer`
>
> The ID of the currency for the training cost.
>
> **company\_training\_category\_id** `integer`
>
> The ID of the training category this course belongs to.
>
> **company\_training\_provider\_id** `integer`
>
> The ID of the training provider or organization delivering the course.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Sickness
>
> **Slug:** `BREATHEHR_UPDATE_SICKNESS`
>
> Tool to update an existing sickness record in BreatheHR. Use when you need to modify sickness details such as status, dates, review notes, or other sickness attributes.
>
> #### Input Parameters
>
> **id** `integer` *required*
>
> The unique identifier of the sickness record to update
>
> **reason** `string`
>
> Reason for the sickness
>
> **status** `string ("open" | "returned" | "rejected" | "clarification" | "closed")`
>
> Enum for sickness status values.
>
> **end\_date** `string`
>
> End date of the sickness in YYYY-MM-DD format
>
> **half\_day** `boolean`
>
> Whether this is a half day sickness
>
> **half\_end** `boolean`
>
> Whether the end date is a half day
>
> **half\_start** `boolean`
>
> Whether the start date is a half day
>
> **start\_date** `string`
>
> Start date of the sickness in YYYY-MM-DD format
>
> **review\_notes** `string`
>
> Review notes for the sickness record
>
> **half\_end\_am\_pm** `string ("am" | "pm")`
>
> Enum for half day period values.
>
> **half\_start\_am\_pm** `string ("am" | "pm")`
>
> Enum for half day period values.
>
> **company\_sicknesstype\_id** `integer`
>
> The ID of the company sickness type
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
