Breathe HR connector icon

Breathe HR Connector

Build in‑app HR automations that sync employee records, surface leave and absence requests, push salary and department updates, and show HR documents to end users — all delivered inside your product.

01

Faster onboarding

Automatically provision new hires across systems during onboarding.

02

Accurate time-off sync

Keep leave and absence data aligned for payroll and scheduling.

03

Governed multi-tenant controls

Store per-customer credentials and apply role-based access and auditing.

04

Embedded experience

Deliver customer-facing workflows natively inside your SaaS product.

CONNECTOR OVERVIEW

What you can integrate and automate with Breathe HR

Teams can integrate employee, leave, absence, salary, department and document workflows with Breathe HR. Use the connector to sync an employee directory, fetch and act on leave_requests and absences, update salaries and departments, and surface company documents for payroll or onboarding workflows. (intercom.help)

PRODUCT USE CASES

Top use cases for Breathe HR integrations

Quickly create in-app automations that keep HR data aligned across customers: sync new hires to your app, push approved leave into payroll, populate salary changes and surface HR documents, all using Cyclr’s low-code orchestration and embedded marketplace.

Keep employee directories in sync

Automatically create and update employee records in Breathe and your app using employees endpoints.

Automate leave and payroll inputs

Fetch leave_requests and absences to trigger payroll runs or schedule updates in downstream systems.

Push salary and compensation changes

Update salary records and export salary history for payroll processing using salaries endpoints.

ORCHESTRATION

How Breathe HR works with Cyclr

Cyclr sits between your SaaS product and Breathe HR to handle authentication, govern access and orchestrate every API call per customer, at scale.

  1. 1

    Your SaaS product

    Your app requests an action for a specific customer.

  2. 2

    Cyclr orchestration

    Cyclr authenticates, applies policies and routes the request.

  3. 3

    Breathe HR

    Breathe HR processes the request and returns a response to your app.

Customer-specific authentication · Governed data movement · Centralized visibility and audit

CONNECTOR COVERAGE

Available connector capabilities

Explore Breathe HR methods you can orchestrate through Cyclr.

Employees11

List Holiday Allowances

Action

List holiday allowances.

List Updated Employees

Action

List updatd employees.

Create Employee

Action

Create an employee.

Get Employee

Action

Get employee.

List New Employees

Action

List new employees.

List Employees

Action

List employees.

List Leave Request for an Employee

Action

List leave request for an employee via ID.

Create Leave Request for an Employee

Action

Create a leave request for an employee.

List Absences of an Employee

Action

List absences of an employee via ID.

Create Sickness for an Employee

Action

Create a sickness for an employee via ID.

Get Sicknesses for an Employee

Action

Get sicknesses for an employee via ID.

Holiday Allowances1

List Holiday Allowances

Action

List holiday allowances.

Leave Requests2

List Leave Requests

Action

List leave requests.

Approve Leave Request

Action

Approve a leave request.

Sicknesses1

Delete Sickness

Action

Delete an employee sickness via ID.

TECHNICAL DETAILS

Breathe HR integration and API details

Review the sourced authentication and API behaviour used when configuring customer-facing Breathe HR integrations in Cyclr.

API and authentication

API host
https://api.breathehr.com/v1
Authentication
API key (header)
Credentials

Account API key (X-API-KEY); optional sandbox API key for testing.

Method categories

Employees, leave_requests, absences, salaries, departments, locations, benefits, documents, expenses, training

View vendor API documentation →

Pagination and rate limits

Pagination

Use page and per_page query parameters; responses include Link and Total HTTP headers. Default 25 records, per_page up to 100. (developer.breathehr.com)

Rate limits

60 requests per 60 seconds per customer; exceeding the limit returns HTTP 429 and a Rate Limit Reached error. (developer.breathehr.com)

IMPLEMENTATION

Authentication at a glance

Account-level API token sent in the X-API-KEY HTTP header; enable the API in the Breathe account first. (developer.breathehr.com)

Authentication method
API key (header)
Credential required

Account API key (X-API-KEY); optional sandbox API key for testing.

Before you begin:

API must be enabled by the account Admin via Configure > Settings > Integrations > API Setup. (intercom.help)

View setup guide

COMMON QUESTIONS

Frequently asked questions

It synchronizes employee, leave and absence records, updates salaries and departments, and accesses company documents for workflows. Use employees, leave_requests, absences, salaries and documents endpoints to keep HR data aligned.

Authentication uses an account-level API token sent in the X-API-KEY HTTP header; enable the API in the Breathe account settings first. (developer.breathehr.com)

Yes. Cyclr stores per-customer API credentials, reuses orchestration across tenants, and delivers integrations embedded inside your SaaS product with governance controls.

Yes. Cyclr can expose connector actions as governed MCP tools with role-based access, auditing and versioned orchestration for safe customer-facing use.