Skip to main content
Breathe HR logo
  • Category: human resources
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 50
  • Triggers: 0
  • Slug: BREATHEHR
  • Version: 20261101_00

Tools

Slug: BREATHEHR_APPROVE_LEAVE_REQUESTSubmit an approval for a BreatheHR leave request by ID. Use this when an authorized user needs to approve a pending leave request.

Input Parameters

integer
required
ID of the leave request to approve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREATHEHR_CREATE_EMPLOYEETool 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

boolean
Whether the employee has HR manager permissions
string
Direct dial-in number for the employee
string
Employee’s date of birth in YYYY-MM-DD format
string
required
Employee’s work email address
string
Employee’s gender identifier
object
Salary information
string ("Current employee" | "Pending leaver" | "Ex-employee")
Employee status enum
integer
Division ID the employee belongs to
integer
Location ID where the employee is based
string
Work extension number
string
Employee’s ethnicity
string
Employee’s job title or position
string
required
Employee’s last name
integer
Department ID the employee belongs to
string
required
Employee’s first name
string
Employee’s middle name
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
string ("Employee" | "Contractor" | "Volunteer")
Person type enum
string
Employee’s work mobile phone number
string
Employee reference number or employee ID
string
Ethnicity identifier
string
Employee’s home telephone number
string
Date employee started their current job role in YYYY-MM-DD format
string ("Single" | "Co-Habiting" | "Married" | "Civil Partnership" | "Separated" | "Divorced" | "Widowed")
Marital status enum
string
Employee’s personal mobile phone number
integer
Working pattern ID defining the employee’s work schedule
string
required
Date employee joined the company in YYYY-MM-DD format
string ("Full-Time" | "Part-Time")
Employment type enum
integer
Holiday allowance ID defining the employee’s leave entitlement
integer
Alternative field for working pattern ID
integer
Alternative field for holiday allowance ID
string
UK National Insurance Number
boolean
If true, ignores working pattern and allows manual entry of time lost when requesting leave
string
Name of the country for statutory holidays
boolean
Whether the employee receives statutory holidays for their country
integer
ID of the country for statutory holidays

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREATHEHR_CREATE_EMPLOYEE_CHANGE_REQUESTTool 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

string
required
The employee ID for whom the change request is being created.
string
required
The field name to change (e.g., ‘job_title’, ‘department’, ‘salary’).
string
required
The new value for the field.
boolean
Set to true to immediately apply the change without approval workflow. If false or omitted, the change requires approval.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREATHEHR_CREATE_EMPLOYEE_EXPENSECreate an employee expense record in BreatheHR for reimbursement or to record a company-paid expense.

Input Parameters

integer
The VAT (Value Added Tax) amount included in the expense, in the smallest currency unit (e.g., cents). Optional for jurisdictions using VAT.
integer
The number of miles traveled if this is a mileage expense. Use together with company_mileage_rate_id for travel reimbursement.
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.
string
The name of the client if the expense is chargeable to a client. Required if chargeable_to_client is true.
string
required
A textual description of the expense (e.g., ‘Office supplies purchase’, ‘Client meeting lunch’).
integer
required
The unique identifier of the employee who incurred the expense.
boolean
Whether a receipt exists for this expense. Set to true if the employee has provided a receipt that can be uploaded separately.
string
required
The date the expense was incurred, in YYYY-MM-DD format.
integer
The identifier for the company project this expense relates to, if applicable. Use to track expenses by project.
boolean
required
Whether the expense amount should be reimbursed/paid to the employee (true) or was paid by the company directly (false).
boolean
Whether this expense should be charged/billed to a client. Set to true if the expense is billable to a client project.
integer
required
The identifier for the expense type/category as defined in the company’s expense configuration.
integer
The identifier for the mileage reimbursement rate if this is a mileage expense. Use this for travel expenses calculated by distance.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREATHEHR_CREATE_EMPLOYEE_EXPENSE_CLAIMTool 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

integer
required
The ID of the employee for whom the expense claim is being created
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREATHEHR_CREATE_EMPLOYEE_SICKNESSTool 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

integer
required
The unique identifier of the employee to create sickness for
string
Reason for the sickness
string ("open" | "returned" | "rejected" | "clarification" | "closed")
Enum for sickness status values.
string
End date of the sickness in YYYY-MM-DD format
boolean
Whether this is a half day sickness
boolean
Whether the end date is a half day
boolean
Whether the start date is a half day
string
required
Start date of the sickness in YYYY-MM-DD format (required)
string
Review notes for the sickness record
string ("am" | "pm")
Enum for half day period values.
string ("am" | "pm")
Enum for half day period values.
integer
required
The ID of the company sickness type (required)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREATHEHR_DELETE_EMPLOYEE_EXPENSETool to delete an employee expense by ID. Use when you need to remove an expense record from the system.

Input Parameters

integer
required
The unique identifier of the employee expense to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREATHEHR_DELETE_EMPLOYEE_TRAINING_COURSETool 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

string
required
The unique identifier of the employee training course record to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREATHEHR_GET_ACCOUNTTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREATHEHR_GET_EMPLOYEETool 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

integer
required
The unique identifier of the employee to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREATHEHR_GET_EMPLOYEE_EXPENSETool to retrieve a specific employee expense record by ID. Use when you need detailed information about a particular expense.

Input Parameters

integer
required
Employee expense record ID to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREATHEHR_GET_LEAVE_REQUESTTool 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

integer
required
The unique identifier of the leave request to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREATHEHR_GET_LEAVE_REQUEST_CANCELLINGTool 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

integer
required
The unique identifier of the leave request to get cancelling information for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREATHEHR_LIST_ABSENCESTool 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

integer
Page of results to fetch. Defaults to 1.
string ("Holiday" | "OtherLeave")
Type of absences to return. Use ‘Holiday’ for holidays or ‘OtherLeave’ for other leave types.
string
Return absences on or before this date. Format: YYYY-MM-DD.
integer
Number of results to return per page. Useful for pagination.
boolean
Return absences where rotacloud is not excluded from integration.
string
Return absences on or after this date. Format: YYYY-MM-DD.
integer
Return absences for this employee only. Alternative to using /employees/:id/absences endpoint.
integer
Return absences for this department only. Alternative to using /departments/:id/absences endpoint.
integer
ID of other leave reason to filter by. Used to filter absences by specific leave reason.
boolean
When set to true, cancelled absences will not be returned in the results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREATHEHR_LIST_BENEFITSTool to retrieve a list of employee benefits with optional pagination. Use when you need to access benefit information across employees.

Input Parameters

integer
Page of results to fetch. Defaults to 1 if not specified.
integer
Number of results to return per page. If not specified, uses API default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREATHEHR_LIST_BONUSESTool to retrieve employee bonuses from BreatheHR with pagination support. Use when you need to list bonuses across the organization.

Input Parameters

integer
Page of results to fetch. Must be a positive integer.
integer
Number of results to return per page. Must be a positive integer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREATHEHR_LIST_CHANGE_REQUESTSTool to list change requests from BreatheHR. Use when you need to retrieve change requests with optional pagination.

Input Parameters

integer
Page of results to fetch.
integer
Number of results to return per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREATHEHR_LIST_COMPANY_DOCUMENTSTool 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

integer
Page number of results to fetch. Defaults to 1 for the first page.
integer
Number of results to return per page. If not specified, the API will use its default page size.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREATHEHR_LIST_COMPANY_PROJECTSTool 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

integer
Page number of results to fetch. Must be a positive integer.
integer
Number of results to return per page. Must be a positive integer if specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREATHEHR_LIST_COMPANY_TRAINING_TYPESTool 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

integer
Page of results to fetch.
integer
Number of results to return per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREATHEHR_LIST_DEPARTMENT_ABSENCESTool 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

integer
required
ID of department to return absences for
integer
Page of results to fetch. Default is 1.
integer
Number of results to return per page. Default is 50, maximum is 100.
boolean
Don’t return cancelled leave requests. Set to true to exclude cancelled absences.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREATHEHR_LIST_DEPARTMENT_BENEFITSTool 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

string
required
Unique identifier of the department to retrieve benefits for.
integer
Page number of results to fetch. Defaults to 1.
integer
Number of results to return per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREATHEHR_LIST_DEPARTMENT_BONUSESTool 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

string
required
The unique identifier of the department to retrieve bonuses for.
integer
Page of results to fetch.
integer
Number of results to return per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREATHEHR_LIST_DEPARTMENT_LEAVE_REQUESTSTool 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

integer
required
ID of department to return leave requests for
integer
Page of results to fetch. Defaults to 1.
integer
Number of results to return per page. Controls pagination size.
boolean
Don’t return cancelled leave requests. Set to true to exclude cancelled requests from the results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREATHEHR_LIST_DEPARTMENTSTool 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

integer
Page of results to fetch.
integer
Number of results to return per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREATHEHR_LIST_DEPARTMENT_SALARIESTool 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

string
required
The unique identifier of the department to retrieve salaries for.
integer
Page of results to fetch.
integer
Number of results to return per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREATHEHR_LIST_DIVISIONSTool to retrieve all company divisions. Use when you need to view organizational divisions or departments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREATHEHR_LIST_EMPLOYEE_ABSENCESTool 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

integer
required
ID of employee to return absences for
integer
Page of results to fetch.
integer
Number of results to return per page.
boolean
Don’t return cancelled leave requests

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREATHEHR_LIST_EMPLOYEE_BENEFITSList benefits for a specific employee by ID, with pagination.

Input Parameters

string
required
The employee ID to retrieve benefits for
integer
Page of results to fetch.
integer
Number of results to return per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREATHEHR_LIST_EMPLOYEE_BONUSESList bonuses for a specific employee by ID, with pagination.

Input Parameters

string
required
Employee ID to fetch bonuses for
integer
Page of results to fetch.
integer
Number of results to return per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREATHEHR_LIST_EMPLOYEE_CHANGE_REQUESTSTool 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

string
required
The employee ID to fetch change requests for
integer
Page of results to fetch
integer
Number of results to return per page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREATHEHR_LIST_EMPLOYEE_EXPENSE_CLAIMSTool 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

integer
Page of results to fetch. Defaults to 1.
integer
Number of results to return per page. If not specified, the API will use its default page size.
integer
Return expense claims for this employee only. If not provided, returns expense claims for all employees.
string ("submitted" | "approved" | "completed" | "rejected")
Filter expense claims by their current state. Only claims matching this state will be returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREATHEHR_LIST_EMPLOYEE_EXPENSESTool to list employee expenses from BreatheHR. Use when you need to retrieve expense records, optionally filtered by employee or claim status.

Input Parameters

integer
Page number of results to fetch. Defaults to 1 if not specified.
integer
Number of results to return per page. If not specified, the API default applies.
integer
Return expenses for this employee only. If not specified, returns expenses for all employees.
boolean
Include claimed expenses in search. If not specified, the API default behavior applies.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREATHEHR_LIST_EMPLOYEE_HOLIDAY_YEARSTool 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

integer
required
ID of employee to return holiday years for
string
Return employee_holiday_years that include this date. Format: YYYY-MM-DD

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREATHEHR_LIST_EMPLOYEE_JOBSTool 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

integer
Page of results to fetch.
integer
Number of results to return per page.
integer
Return jobs for this employee only. If not provided, returns jobs for all employees.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREATHEHR_LIST_EMPLOYEE_LEAVE_REQUESTSTool 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

integer
required
ID of the employee to return leave requests for
integer
Page of results to fetch. Defaults to 1.
integer
Number of results to return per page. Maximum is 100, default is 25.
boolean
Don’t return cancelled leave requests when set to true

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREATHEHR_LIST_EMPLOYEESList 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

integer
Page of results to fetch. Defaults to 1.
string ("hr" | "line_manager" | "either" | "neither")
Filter employees by their role type.
integer
Number of results to return per page. Maximum is 100, default is 25.
boolean
Return only employees where rotacloud integration is not excluded. When true, filters to employees included in RotaCloud integration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREATHEHR_LIST_EMPLOYEE_SALARIESTool to list salaries for a specific employee. Use when you need to retrieve salary history or current salary information for an employee.

Input Parameters

string
required
The unique identifier of the employee whose salaries to retrieve.
integer
Page of results to fetch.
integer
Number of results to return per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREATHEHR_LIST_EMPLOYEE_TRAINING_COURSESTool 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

integer
Page of results to fetch.
integer
Number of results to return per page.
integer
Return training courses for this employee only. If not provided, returns courses for all employees.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREATHEHR_LIST_HOLIDAY_ALLOWANCESTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREATHEHR_LIST_LEAVE_REQUESTSTool 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

integer
Page of results to fetch. Defaults to 1.
string
Return leave requests starting on or before this date (YYYY-MM-DD format)
integer
Number of results to return per page. Controls pagination size.
boolean
Return leave requests where rotacloud is not excluded from integration. When true, filters to leave requests included in RotaCloud integration.
string
Return leave requests starting on or after this date (YYYY-MM-DD format)
integer
Return leave requests for this employee only
integer
Return leave requests for this department only
boolean
Don’t return cancelled leave requests. Set to true to exclude cancelled requests from the results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREATHEHR_LIST_LOCATIONSTool 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

integer
Page of results to fetch.
integer
Number of results to return per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREATHEHR_LIST_OTHER_LEAVE_REASONSTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREATHEHR_LIST_SALARIESTool 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

integer
Page of results to fetch.
integer
Number of results to return per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREATHEHR_LIST_SICKNESSESList 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

integer
Page of results to fetch.
string
Return sicknesses starting on or before this date in YYYY-MM-DD format
integer
Number of results to return per page.
boolean
Return sicknesses for employees without exclude from rotacloud. When true, filters to employees included in RotaCloud integration.
string
Return sicknesses starting on or after this date in YYYY-MM-DD format
integer
Return sicknesses for this employee only
integer
Return sicknesses for this department only

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREATHEHR_LIST_WORKING_PATTERNSList BreatheHR working patterns with pagination support. Results can include weekly schedules, hours per day, default status, and day-by-day breakdowns.

Input Parameters

integer
Page of results to fetch. Defaults to 1.
integer
Number of results to return per page. Maximum is 100, default is 25.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREATHEHR_REJECT_LEAVE_REQUESTTool 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

integer
required
ID of the leave request to reject
string
required
Reason for rejecting the leave request. This will be communicated to the employee.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREATHEHR_UPDATE_EMPLOYEE_EXPENSE_CLAIMTool 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

integer
required
The unique identifier of the employee expense claim to update.
boolean
required
Whether to approve (true) or reject (false) the expense claim.
string
Reason for rejecting the expense claim. Required when approve is false.
integer
required
The unique identifier of the employee who is approving or rejecting the claim.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREATHEHR_UPDATE_EMPLOYEE_TRAINING_COURSETool 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

string
required
The unique identifier of the employee training course to update. This is required to identify which training record to modify.
string
The cost of the training course as a float string.
string
The name or title of the training course.
string
Additional notes or comments about the training course.
string
The end date of the training course in date format (YYYY-MM-DD).
string ("Requested" | "Approved" | "Pending" | "Rejected" | "Booked" | "Completed" | "Cancelled" | "Non-attended" | "Expired")
Status values for employee training courses.
string ("Passed" | "passed" | "Failed" | "failed")
Outcome values for completed training courses.
boolean
Whether the training is a half-day course (true) or full-day (false).
string
The start date of the training course in date format (YYYY-MM-DD).
string
The date for following up on the training in date format (YYYY-MM-DD).
string ("am" | "pm")
Period for half-day training courses.
integer
The ID of the training type classification.
integer
The ID of the currency for the training cost.
integer
The ID of the training category this course belongs to.
integer
The ID of the training provider or organization delivering the course.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BREATHEHR_UPDATE_SICKNESSTool 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

integer
required
The unique identifier of the sickness record to update
string
Reason for the sickness
string ("open" | "returned" | "rejected" | "clarification" | "closed")
Enum for sickness status values.
string
End date of the sickness in YYYY-MM-DD format
boolean
Whether this is a half day sickness
boolean
Whether the end date is a half day
boolean
Whether the start date is a half day
string
Start date of the sickness in YYYY-MM-DD format
string
Review notes for the sickness record
string ("am" | "pm")
Enum for half day period values.
string ("am" | "pm")
Enum for half day period values.
integer
The ID of the company sickness type

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not