Requirements
To use Breathe HR on WEXTL you need an active account and an API access token from your account settings.[3]
Get your Breathe HR credentials
- EnvironmentselectRequired
- API KeypasswordRequired
Log in to your account, go to Configure → Settings → API Setup, and generate your API key from there.
[1]
Connect Breathe HR in WEXTL
- Log in to your WEXTL account, add the Breathe HR node module to your workflow, and click Create new credential.
- Optional: In the Credential name field, enter a name for the credential.
- Enter the authentication credentials you copied from your Breathe HR account, or follow the on-screen instructions to create the credential.
- If prompted, authenticate your account and confirm access.
- If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Notes
Credentials are org-scoped; share them with teammates from the Credentials picker on any of its nodes.For detailed information on connecting an application, see Connect an application →
Breathe HR node modules
The list below is a reference of every Breathe HR node module the integration supports. You will be able to pick any of them on the workflow canvas while building automations.
Open any Breathe HR node module below to inspect its input parameters, outputs, and connection requirements.
Watch AbsenceTrigger
| Field | Type |
|---|---|
| Employee | object |
| ID | text |
| text | |
| First name | text |
| Last name | text |
| Approved by | text |
| Leave reason | text |
| Deducted | text |
| Work units | text |
| ID | number |
| Start date | text |
| Half start | boolean |
| Half start am pm | text |
| End date | text |
| Half end | boolean |
| Half end am pm | text |
| Cancelled | boolean |
| Notes | text |
| Type | text |
| Created at | date |
| Updated at | date |
Watch BenefitsTrigger
| Field | Type |
|---|---|
| ID | text |
| Start date | text |
| End date | text |
| Review date | text |
| Amount | text |
| Provider | text |
| Pension opt out | text |
| Employer contribution | text |
| Employee contribution | text |
| Created at | date |
| Updated at | date |
Watch BonusesTrigger
| Field | Type |
|---|---|
| ID | text |
| Description | text |
| Amount | text |
| Award date | text |
| Created at | date |
| Updated at | date |
Watch Change RequestsTrigger
| Field | Type |
|---|---|
| ID | text |
| Field name | text |
| Value | text |
| Approved | text |
| Approved at | text |
| Created at | date |
| Updated at | date |
Watch DepartmentsTrigger
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Created at | date |
| Updated at | date |
Watch Employee JobsTrigger
| Field | Type |
|---|---|
| Title | text |
| Fulltime parttime | text |
| Start date | text |
| End date | text |
| Contract end date | text |
| Created at | date |
| Updated at | date |
Watch EmployeesTrigger
| Field | Type |
|---|---|
| Length of service in months | text |
| Age | text |
| Full or part time | text |
| Notice period | text |
| Photo URL | text |
| Working pattern | text |
| Total working hours | text |
| Holiday allowance | text |
| Line manager | text |
| Is line manager | text |
| Holiday approver | text |
| Department | text |
| Division | text |
| Location | text |
| Gender | text |
| Statutory holiday country | text |
| Receives statutory holidays | text |
| Salary | text |
| Status | text |
| Job start date | text |
Watch Leave RequestsTrigger
| Field | Type |
|---|---|
| ID | text |
| Start date | text |
| Half start | text |
| Half start am pm | text |
| End date | text |
| Half end | text |
| Half end am pm | text |
| Action | text |
| Status | text |
| Notes | text |
| Created at | date |
| Updated at | date |
Get a Cancelling Leave RequestAction
Get a Leave RequestAction
Get AbsencesSearch
| Field | Type |
|---|---|
| Type | choice |
| Other Leave Reason ID | number |
| Exclude Cancelled Absences | boolean |
| Employee ID | choice |
| Department ID | choice |
| Start Date | date |
| End Date | date |
| Rotacloud | boolean |
| Limit | number |
| Field | Type |
|---|---|
| Employee | object |
| ID | text |
| text | |
| First name | text |
| Last name | text |
| Approved by | text |
| Leave reason | text |
| Deducted | text |
| Work units | text |
| ID | number |
| Start date | text |
| Half start | boolean |
| Half start am pm | text |
| End date | text |
| Half end | boolean |
| Half end am pm | text |
| Cancelled | boolean |
| Notes | text |
| Type | text |
| Created at | date |
| Updated at | date |
Get Absences for a DepartmentSearch
| Field | Type |
|---|---|
Department IDRequired | choice |
| Exclude Cancelled Absences | boolean |
| Limit | number |
| Field | Type |
|---|---|
| Employee | object |
| ID | text |
| text | |
| First name | text |
| Last name | text |
| Approved by | text |
| Leave reason | text |
| Deducted | text |
| Work units | text |
| ID | number |
| Start date | text |
| Half start | boolean |
| Half start am pm | text |
| End date | text |
| Half end | boolean |
| Half end am pm | text |
| Cancelled | boolean |
| Notes | text |
| Type | text |
| Created at | date |
| Updated at | date |
Get an EmployeeAction
| Field | Type |
|---|---|
Employee IDRequired | choice |
| Field | Type |
|---|---|
| Length of service in months | text |
| Age | text |
| Full or part time | text |
| Notice period | text |
| Photo URL | text |
| Working pattern | text |
| Total working hours | text |
| Holiday allowance | text |
| Line manager | text |
| Is line manager | text |
| Holiday approver | text |
| Department | text |
| Division | text |
| Location | text |
| Gender | text |
| Statutory holiday country | text |
| Receives statutory holidays | text |
| Salary | text |
| Status | text |
| Job start date | text |
Get an Employee ExpenseAction
| Field | Type |
|---|---|
Employee Expense Record IDRequired | choice |
| Field | Type |
|---|---|
| ID | text |
| Employee ID | text |
| Account ID | text |
| Employee expense claim ID | text |
| Expense date | text |
| Description | text |
| Company expense type ID | text |
| Company project ID | text |
| Company mileage rate ID | text |
| Amount | text |
| Miles | text |
| Payable to employee | text |
| Chargeable to client | text |
| Client name | text |
| Vat | text |
Get an Expense ClaimAction
| Field | Type |
|---|---|
Expense Claim IDRequired | choice |
| Field | Type |
|---|---|
| Employee | text |
| Employee expenses | text |
| ID | text |
| Account ID | text |
| Employee ID | text |
| Remuneration currency ID | text |
| Submitted date | text |
| Approver ID | text |
| Approved date | text |
| Rejected by ID | text |
| Rejected date | text |
| Paid by ID | text |
| Paid date | text |
| Closedby ID | text |
| Closed date | text |
| Description | text |
| Old claim status | text |
| State | text |
| Reject reason | text |
| Paid | text |
Get BenefitsSearch
Get Benefits for a DepartmentSearch
Get BonusesSearch
Get Bonuses for a DepartmentSearch
Get Change RequestsSearch
Get DepartmentsSearch
Get Employee Expense ClaimsSearch
| Field | Type |
|---|---|
Employee IDRequired | choice |
| State Filter | choice |
| Limit | number |
| Field | Type |
|---|---|
| Employee | text |
| Employee expenses | text |
| ID | text |
| Account ID | text |
| Employee ID | text |
| Remuneration currency ID | text |
| Submitted date | text |
| Approver ID | text |
| Approved date | text |
| Rejected by ID | text |
| Rejected date | text |
| Paid by ID | text |
| Paid date | text |
| Closedby ID | text |
| Closed date | text |
| Description | text |
| Old claim status | text |
| State | text |
| Reject reason | text |
| Paid | text |
Get Employee ExpensesSearch
| Field | Type |
|---|---|
| Employee ID | choice |
| Show Claimed | boolean |
| Limit | number |
| Field | Type |
|---|---|
| ID | text |
| Employee ID | text |
| Account ID | text |
| Employee expense claim ID | text |
| Expense date | text |
| Description | text |
| Company expense type ID | text |
| Company project ID | text |
| Company mileage rate ID | text |
| Amount | text |
| Miles | text |
| Payable to employee | text |
| Chargeable to client | text |
| Client name | text |
| Vat | text |
Get Employee JobsSearch
Get Employee Training CoursesSearch
| Field | Type |
|---|---|
Employee IDRequired | choice |
| Limit | number |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Start on | text |
| End on | text |
| Half day | text |
| Half day am pm | text |
| Expires on | text |
| Hours | text |
| Cost | text |
| Status | text |
| Outcome | text |
| Remuneration currency ID | text |
| Rejection reason | text |
| Notes | text |
| Followup date | text |
| Employee | text |
| Company training type | text |
| Company training category | text |
| Company training provider | text |
Get EmployeesSearch
| Field | Type |
|---|---|
| Filter | choice |
| Rotacloud | boolean |
| Limit | number |
| Field | Type |
|---|---|
| Length of service in months | text |
| Age | text |
| Full or part time | text |
| Notice period | text |
| Photo URL | text |
| Working pattern | text |
| Total working hours | text |
| Holiday allowance | text |
| Line manager | text |
| Is line manager | text |
| Holiday approver | text |
| Department | text |
| Division | text |
| Location | text |
| Gender | text |
| Statutory holiday country | text |
| Receives statutory holidays | text |
| Salary | text |
| Status | text |
| Job start date | text |
Get Leave RequestsSearch
| Field | Type |
|---|---|
| Start Date | date |
| End Date | date |
| Exclude Cancelled Requests | boolean |
| Employee ID | choice |
| Department ID | choice |
| Rotacloud | boolean |
| Limit | number |
| Field | Type |
|---|---|
| ID | text |
| Start date | text |
| Half start | text |
| Half start am pm | text |
| End date | text |
| Half end | text |
| Half end am pm | text |
| Action | text |
| Status | text |
| Notes | text |
| Created at | date |
| Updated at | date |
Get Leave RequestsSearch
Get Other Leave ReasonsSearch
Get Salaries for a DepartmentSearch
Get SicknessesSearch
| Field | Type |
|---|---|
| Start Date | date |
| End Date | date |
| Employee ID | choice |
| Department ID | choice |
| Rotacloud | boolean |
| Limit | number |
| Field | Type |
|---|---|
| Company sicknesstype | text |
| Employee | text |
| ID | text |
| Start date | text |
| End date | text |
| Half start | text |
| Half start am pm | text |
| Half end | text |
| Half end am pm | text |
| Deducted | text |
| Status | text |
| Review notes | text |
| Fit note required | text |
| Reason | text |
Approve a Leave RequestAction
Approve an Employee Change RequestAction
Approve or Reject an Expense ClaimAction
| Field | Type |
|---|---|
Approve Expense ClaimRequired | boolean |
Approver/Rejector IDRequired | number |
| Rejection Reason | text |
| Field | Type |
|---|---|
| Employee | text |
| Employee expenses | text |
| ID | text |
| Account ID | text |
| Employee ID | text |
| Remuneration currency ID | text |
| Submitted date | text |
| Approver ID | text |
| Approved date | text |
| Rejected by ID | text |
| Rejected date | text |
| Paid by ID | text |
| Paid date | text |
| Closedby ID | text |
| Closed date | text |
| Description | text |
| Old claim status | text |
| State | text |
| Reject reason | text |
| Paid | text |
Cancel an AbsenceAction
Create an EmployeeAction
| Field | Type |
|---|---|
First NameRequired | text |
Last NameRequired | text |
EmailRequired | |
Company Join DateRequired | date |
| Middle Name | text |
| Gender | text |
| Date of Birth | date |
| Marital Status | text |
| Nationality | text |
| National Insurance Number | text |
| Ethnicity | text |
| Ethnicity ID | text |
| DDI | text |
| Work Extension | text |
| Work Mobile | text |
| Personal Mobile | text |
| Home Telephone | text |
| Status | text |
| Job Title | text |
| Full or Part Time | text |
| Field | Type |
|---|---|
| Length of service in months | text |
| Age | text |
| Full or part time | text |
| Notice period | text |
| Photo URL | text |
| Working pattern | text |
| Total working hours | text |
| Holiday allowance | text |
| Line manager | text |
| Is line manager | text |
| Holiday approver | text |
| Department | text |
| Division | text |
| Location | text |
| Gender | text |
| Statutory holiday country | text |
| Receives statutory holidays | text |
| Salary | text |
| Status | text |
| Job start date | text |
Create an Employee ExpenseAction
| Field | Type |
|---|---|
Employee IDRequired | choice |
Expense DateRequired | date |
DescriptionRequired | text |
Company Expense Type IDRequired | number |
AmountRequired | number |
Payable to EmployeeRequired | boolean |
| VAT | number |
| Company Project ID | number |
| Company Mileage Rate ID | number |
| Miles | number |
| Chargeable to Client | boolean |
| Client Name | text |
| Has Receipt | boolean |
| Field | Type |
|---|---|
| ID | text |
| Employee ID | number |
| Account ID | number |
| Employee expense claim ID | text |
| Expense date | text |
| Description | text |
| Company expense type ID | number |
| Company project ID | text |
| Company mileage rate ID | text |
| Amount | text |
| Miles | text |
| Payable to employee | boolean |
| Chargeable to client | text |
| Client name | text |
| Vat | text |
Create an Expense ClaimAction
| Field | Type |
|---|---|
Employee IDRequired | choice |
| Employee Expense IDs | choice |
| Field | Type |
|---|---|
| Employee | text |
| Employee expenses | text |
| ID | text |
| Account ID | text |
| Employee ID | text |
| Remuneration currency ID | text |
| Submitted date | text |
| Approver ID | text |
| Approved date | text |
| Rejected by ID | text |
| Rejected date | text |
| Paid by ID | text |
| Paid date | text |
| Closedby ID | text |
| Closed date | text |
| Description | text |
| Old claim status | text |
| State | text |
| Reject reason | text |
| Paid | text |
Create Employee TrainingAction
| Field | Type |
|---|---|
Employee IDRequired | choice |
NameRequired | text |
Company Training Type IDRequired | number |
| Status | text |
| Remuneration Currency ID | number |
| Company Training Category ID | number |
| Company Training Provider ID | number |
| Start On | date |
| Half Day AM/PM | choice |
| End On | date |
| Followup Date | date |
| Cost | number |
| Outcome | text |
| Notes | text |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Start on | text |
| End on | text |
| Half day | text |
| Half day am pm | text |
| Expires on | text |
| Hours | text |
| Cost | text |
| Status | text |
| Outcome | text |
| Remuneration currency ID | text |
| Rejection reason | text |
| Notes | text |
| Followup date | text |
| Employee | text |
| Company training type | text |
| Company training category | text |
| Company training provider | text |
Delete a SicknessAction
| Field | Type |
|---|---|
Sickness IDRequired | choice |
Delete an Employee ExpenseAction
| Field | Type |
|---|---|
Employee Expense Record IDRequired | choice |
Delete an Expense ClaimAction
| Field | Type |
|---|---|
Expense Claim IDRequired | choice |
Delete Employee TrainingAction
| Field | Type |
|---|---|
| ID | choice |
Make an API Calluniversal
Reject a Leave RequestAction
Update a SicknessAction
| Field | Type |
|---|---|
Sickness IDRequired | choice |
| Company Sickness Type | text |
| Employee | text |
| Start Date | date |
| End Date | date |
| Half Start | boolean |
| Half Start AM/PM | choice |
| Half End | boolean |
| Half End AM/PM | choice |
| Deducted | boolean |
| Status | text |
| Review Notes | text |
| Fit Note Required | boolean |
| Reason | text |
| Field | Type |
|---|---|
| Company sicknesstype | text |
| Employee | text |
| ID | text |
| Start date | text |
| End date | text |
| Half start | text |
| Half start am pm | text |
| Half end | text |
| Half end am pm | text |
| Deducted | text |
| Status | text |
| Review notes | text |
| Fit note required | text |
| Reason | text |
Update an Employee ExpenseAction
| Field | Type |
|---|---|
Employee Expense Record IDRequired | choice |
| Employee ID | choice |
| Account ID | text |
| Employee Expense Claim ID | choice |
| Expense Date | date |
| Description | text |
| Company Expense Type ID | text |
| Company Project ID | text |
| Company Mileage Rate ID | text |
| Amount | number |
| Miles | number |
| Payable to Employee | boolean |
| Chargeable to Client | boolean |
| Client Name | text |
| VAT | number |
| Field | Type |
|---|---|
| ID | text |
| Employee ID | choice |
| Account ID | text |
| Employee expense claim ID | choice |
| Expense date | text |
| Description | text |
| Company expense type ID | text |
| Company project ID | text |
| Company mileage rate ID | text |
| Amount | text |
| Miles | text |
| Payable to employee | text |
| Chargeable to client | text |
| Client name | text |
| Vat | text |
Update Employee TrainingAction
| Field | Type |
|---|---|
IDRequired | choice |
| Name | text |
| Company Training Type ID | number |
| Status | text |
| Remuneration Currency ID | number |
| Company Training Category ID | number |
| Company Training Provider ID | number |
| Start On | date |
| Half Day | date |
| Half Day AM/PM | choice |
| End On | date |
| Followup Date | date |
| Cost | number |
| Outcome | text |
| Notes | text |
| Field | Type |
|---|---|
| ID | text |
| Name | text |
| Start on | text |
| End on | text |
| Half day | text |
| Half day am pm | text |
| Expires on | text |
| Hours | text |
| Cost | text |
| Status | text |
| Outcome | text |
| Remuneration currency ID | text |
| Rejection reason | text |
| Notes | text |
| Followup date | text |
| Employee | text |
| Company training type | text |
| Company training category | text |
| Company training provider | text |
Templates
Look for Breathe HR templates in the WEXTL template library.
Browse templates →Explore alternative apps
- BrioHR[2]HR management platform for employee data, leave, payroll-ready records, and people operations.
- CalamariHR leave, attendance, and timesheet management for growing teams.
- BuddyPunchEmployee time clock and attendance tracking for hourly teams.
- Base.vnWorkplace suite for HR, requests, meetings, time off, and team operations.
- actiTIMETime tracking and project work-assignment software for teams and leave management.
References
- WEXTL® Breathe HR Source Code connector implementation.
- Our users use cases and automations.
- Official API Documentation for Breathe HR.
- WEXTL® visual workflow builder data.
Last updated: Jul 23, 2026 22:38
