--- title: Breathe API Integration on Truto slug: breathe category: HRIS canonical: "https://truto.one/integrations/detail/breathe/" --- # Breathe API Integration on Truto **Category:** HRIS **Status:** Generally available ## Unified APIs ### Unified HRIS API - **Benefits** — Benefits represent the benefits for an Employee - **Companies** — Companies represent the companies in HRIS - **Company Benefits** — Represents the benefits offered by a company - **Employee Compensations** — Represent the compensation configuration for an Employee - **Employees** — Represents an employee in HRIS - **Employments** — Employments represent a job position at a company. - **Groups** — Groups represent the groups for an Employee - **Timeoff Requests** — Represent the time off requests for an Employee ## How it works 1. **Link your customer's Breathe account.** Use Truto's frontend SDK; we handle every OAuth and API key flow so you don't need to create the OAuth app. 2. **Authentication is automatic.** Truto refreshes tokens, stores credentials securely, and injects them into every API request. 3. **Call Truto's API to reach Breathe.** The Proxy API is a 1-to-1 mapping of the Breathe API. 4. **Get a unified response format.** Every response uses a single shape, with cursor-based pagination and data in the `result` field. ## Use cases - **Automate employee onboarding and offboarding workflows** — IT and identity management SaaS companies can sync Breathe's employee roster to automatically provision or revoke access to tools like Google Workspace, Slack, and CRMs when employees join or leave — critical for GDPR compliance in the UK market. - **Sync time-off data into scheduling and payroll tools** — Workforce management and payroll platforms can pull approved holidays and sickness records from Breathe to prevent scheduling conflicts and calculate accurate pay, eliminating the manual back-and-forth between HR and operations teams. - **Push hired candidates from your ATS into Breathe** — Applicant tracking systems can write new employee profiles directly into Breathe once a candidate is marked as hired, removing the need for office managers to manually re-enter personal details, department, and employment information. - **Power employee milestone automations with live HR data** — Employee engagement, rewards, and corporate gifting platforms can read employee records from Breathe to trigger automated actions on birthdays, work anniversaries, or probation end dates — without HR uploading spreadsheets. - **Feed compensation data into financial planning tools** — FP&A and budgeting SaaS companies can ingest salary and compensation data from Breathe to keep headcount cost models accurate and up-to-date, especially for UK SMEs managing budgets in GBP. ## What you can build - **Real-time employee directory sync** — Continuously import employees, departments, and reporting structures from Breathe to keep your product's user roster current without manual CSV uploads. - **Automated JML (Joiner, Mover, Leaver) triggers** — Detect new hires, role changes, and terminations in Breathe and fire downstream provisioning or de-provisioning workflows in your platform. - **Holiday and sickness calendar overlay** — Pull approved time-off requests from Breathe and surface them as blocked-out periods in your scheduling, resource planning, or payroll UI. - **One-click new hire creation from your app** — Let users push a hired candidate's profile — including name, department, start date, and employment details — directly into Breathe from your product's workflow. - **Department-based access policy mapping** — Read Breathe's group and department structure to automatically assign software licenses, permissions, or content access based on organizational hierarchy. - **Compensation change feed for payroll and budgeting** — Surface salary updates and effective dates from Breathe into your financial planning or payroll product to keep compensation data in sync. ## FAQs ### How does authentication work with Breathe? Breathe uses API Key authentication. Your end users generate an API key from their Breathe account, and Truto handles storing and managing the credential securely so you don't have to build auth flows yourself. ### What data can I access through Truto's Unified HRIS API for Breathe? Truto's Unified HRIS API maps Breathe data to standardized models including Employees, Employments, Employee Compensations, Timeoff Requests, Groups, Companies, Company Benefits, and Benefits. This covers core employee records, departments, salary data, and leave tracking. ### Does Breathe support write operations through Truto? Yes. The Unified HRIS API supports read and write operations on supported models such as Employees and Employments, enabling use cases like creating new employee records from an ATS or updating employment details programmatically. ### How does Breathe handle time-off data — holidays vs. sickness? Breathe distinguishes between planned leave (holidays) and unplanned absence (sickness). Both are accessible through the Timeoff Requests unified model, so you can differentiate leave types when syncing into your scheduling or payroll workflows. ### Are there custom tools available for Breathe beyond the Unified API? Breathe does not have pre-built custom tools yet — they are built on request. If you need access to Breathe-specific endpoints or data not covered by the Unified HRIS API, Truto can build custom tools tailored to your use case. ### Is Breathe primarily a UK-focused platform? Does that affect the integration? Yes, Breathe is built primarily for UK SMEs with a secondary presence in Australia. The data uses UK-centric terminology (e.g., holidays instead of PTO) and compensation is typically in GBP. Truto's unified models normalize this so your integration works consistently across HRIS providers regardless of regional conventions.