BreatheHR API Directory

BreatheHR is a comprehensive HR management software designed to streamline human resource processes for small to medium-sized businesses. By offering a centralized platform, it enables organizations to efficiently manage personal data, company documents, holiday requests, expenses, and sick leave. This user-friendly software enhances workforce connectivity and ensures that HR tasks are handled with precision and ease, allowing businesses to focus on growth and productivity.

One of the standout features of BreatheHR is its ability to integrate seamlessly with other business tools through the BreatheHR API. This integration capability allows businesses to customize their HR management experience, ensuring that all systems work in harmony. By leveraging the BreatheHR API, companies can automate data flows, reduce manual entry, and maintain accurate records, ultimately leading to improved efficiency and decision-making. As businesses continue to evolve, BreatheHR remains a vital tool in the HR domain, offering flexibility and scalability to meet diverse organizational needs.

Key highlights of BreatheHR APIs

• Easy Data Access:
  • The breatheHR API allows seamless integration with existing systems, providing effortless access to employee data across multiple applications.
• Automation:
  • Automate business operations and data flow across systems, reducing manual data entry and saving time.
• Custom Integration:
  • Open-source and developer-friendly, the breatheHR API supports custom integrations with third-party software for tailored solutions.
• Developer-Friendly:
  • Designed with developers in mind, the API offers flexibility and ease of use for creating custom solutions.

BreatheHR API Endpoints

Absences

• get https://api.breathehr.com/v1/absences : Get Absences
• post https://api.breathehr.com/v1/absences/{id}/cancel : Cancel Absence Request

Account

• get https://api.breathehr.com/v1/account : Get Account Details

Bonuses

• get https://api.breathehr.com/v1/bonuses : Get Bonuses

Change Requests

• get https://api.breathehr.com/v1/change_requests : Get Change Requests

Company

• get https://api.breathehr.com/v1/company_training_types : Get Company Training Types
• get https://api.breathehr.com/v1/departments : Get Company Departments
• get https://api.breathehr.com/v1/divisions : Get Company Divisions
• get https://api.breathehr.com/v1/locations : Get Company Locations

Department

• get https://api.breathehr.com/v1/departments/{id}/absences : Get Department Absences
• get https://api.breathehr.com/v1/departments/{id}/benefits : Get Department Benefits
• get https://api.breathehr.com/v1/departments/{id}/bonuses : Get Department Bonuses
• get https://api.breathehr.com/v1/departments/{id}/leave_requests : Get Leave Requests for a Department
• get https://api.breathehr.com/v1/departments/{id}/salaries : Get Department Salaries

Employee Expenses

• post https://api.breathehr.com/v1/employee_expense_claims : Create Employee Expense Claims
• put https://api.breathehr.com/v1/employee_expense_claims/{id} : Update Employee Expense Claim
• post https://api.breathehr.com/v1/employee_expenses : Create Employee Expenses
• get https://api.breathehr.com/v1/employee_expenses/{id} : Get Employee Expenses by ID

Employee

• get https://api.breathehr.com/v1/employee_jobs : Get Employee Jobs
• get https://api.breathehr.com/v1/employee_training_courses : Get Employee Training Courses
• delete https://api.breathehr.com/v1/employee_training_courses/{id} : Delete Employee Training Course
• post https://api.breathehr.com/v1/employees : Create New Employee Record
• post https://api.breathehr.com/v1/employees/{employee_id}/change_requests/{id}/approve : Approve Employee Change Request
• get https://api.breathehr.com/v1/employees/{id} : Get Employee Details
• get https://api.breathehr.com/v1/employees/{id}/absences : Get Employee Absences
• get https://api.breathehr.com/v1/employees/{id}/benefits : Get Employee Benefits
• get https://api.breathehr.com/v1/employees/{id}/bonuses : Get Employee Bonuses
• post https://api.breathehr.com/v1/employees/{id}/change_requests : Create Employee Change Request
• post https://api.breathehr.com/v1/employees/{id}/leave_requests : Create Leave Request for Employee
• get https://api.breathehr.com/v1/employees/{id}/sicknesses : Get Employee Sickness Records

Leave Requests

• get https://api.breathehr.com/v1/leave_requests : Get Leave Requests
• get https://api.breathehr.com/v1/leave_requests/{id} : Get Leave Request Details
• post https://api.breathehr.com/v1/leave_requests/{id}/approve : Approve Leave Request
• get https://api.breathehr.com/v1/leave_requests/{id}/cancelling : Get Leave Request Cancelling Details
• post https://api.breathehr.com/v1/leave_requests/{id}/reject : Reject Leave Request

Holiday

• get https://api.breathehr.com/v1/holiday_allowances : Get Holiday Allowances
• get https://api.breathehr.com/v1/statutory_holiday_countries : Get Statutory Holiday Countries

Other

• get https://api.breathehr.com/v1/other_leave_reasons : Get Other Leave Reasons
• get https://api.breathehr.com/v1/salaries : Get Employee Salaries
• get https://api.breathehr.com/v1/sicknesses : Get Sickness Records
• delete https://api.breathehr.com/v1/sicknesses/{id} : Delete Sickness Record
• get https://api.breathehr.com/v1/working_patterns : Get Working Patterns

‍

BreatheHR API FAQs

How do I enable API access in BreatheHR?

• Answer: To enable API access in BreatheHR:some text
  1. Log in to your BreatheHR account as an Admin.
  2. Navigate to Configure > Settings > Integrations > API Setup.
  3. Click on Enable API and confirm the action.
  4. Once enabled, your production API key will be displayed.
• Source: How to enable the Breathe API | Breathe Knowledgebase

What authentication method does the BreatheHR API use?

• Answer: The BreatheHR API uses API key-based authentication. Include your API key in the X-API-KEY header of your HTTP requests to authenticate.
• Source: Breathe Developer Documentation

Are there rate limits for the BreatheHR API?

• Answer: The official documentation does not specify explicit rate limits for the BreatheHR API. However, it's recommended to implement error handling for potential rate limiting responses to ensure robust integration.
• Source: Breathe Developer Documentation

Can I retrieve employee data using the BreatheHR API?

• Answer: Yes, you can retrieve employee data by making a GET request to the /employees endpoint. This will return a list of employees and their details.
• Source: Breathe Developer Documentation

Does the BreatheHR API support webhooks?

• Answer: As of the latest available information, the BreatheHR API does not natively support webhooks. For real-time data updates, consider implementing periodic polling or integrating with third-party services that provide webhook functionality.
• Source: Breathe Developer Documentation

‍

Get Started with BreatheHR API Integration

For quick and seamless integration with BreatheHR API, Knit API offers a convenient solution. It’s AI powered integration platform allows you to build any BreatheHR API Integration use case. By integrating with Knit just once, you can integrate with multiple other CRMs, HRIS, Accounting, and other systems in one go with a unified approach. Knit takes care of all the authentication, authorization, and ongoing integration maintenance. This approach not only saves time but also ensures a smooth and reliable connection to BreatheHR API.‍

To sign up for free, click here. To check the pricing, see our pricing page.