Table of Contents
Meet the most popular HR software and support service for SMEs. With HR advice, staff wellbeing and even a clocking in app, discover how BrightHR saves you time, money & effort now.
API Overview
BrightHR is a cloud-based human capital management (HCM) software designed to streamline HR processes for businesses of all sizes. It offers a comprehensive suite of features including employee onboarding, payroll processing, time and attendance tracking, performance management, and benefits administration. BrightHR's user-friendly interface and mobile accessibility make it easy for HR professionals and employees to manage HR tasks efficiently. With its robust reporting capabilities, businesses can gain valuable insights into their workforce and make data-driven decisions.
BrightHR's API overview provides developers with detailed documentation and resources to integrate BrightHR's functionality into their applications. The REST APIs allow seamless data exchange between external systems and BrightHR, enabling businesses to automate processes and extend the capabilities of their HR software. Webhooks offer real-time notifications for specific events, allowing developers to respond to changes in employee data or HR processes promptly. Rate limits ensure the stability and performance of the API by limiting the number of requests per minute, preventing overloading of the system. The API documentation provides clear instructions, code samples, and error handling guidance, empowering developers to build robust and efficient integrations with BrightHR.
APIs
Method: GET
Description: Get a list of activities for a given company..
Endpoint: /api/2.0/companies/{company_id}/activities
Parameters: company_id
Method: POST
Description: Create a new activity for a given company..
Endpoint: /api/2.0/companies/{company_id}/activities
Parameters: company_id
Method: GET
Description: Get a list of activities for a given company..
Endpoint: /api/2.0/companies/{company_id}/activities/{activity_id}
Parameters: company_id
Method: PUT
Description: Update an existing activity for a given company..
Endpoint: /api/2.0/companies/{company_id}/activities/{activity_id}
Parameters: company_id
Method: DELETE
Description: Delete an existing activity for a given company..
Endpoint: /api/2.0/companies/{company_id}/activities/{activity_id}
Parameters: company_id
Method: GET
Description: Get a list of appraisals for a given company..
Endpoint: /api/2.0/companies/{company_id}/appraisals
Parameters: company_id
Method: POST
Description: Create a new appraisal for a given company..
Endpoint: /api/2.0/companies/{company_id}/appraisals
Parameters: company_id
Method: GET
Description: Get a list of appraisals for a given company..
Endpoint: /api/2.0/companies/{company_id}/appraisals/{appraisal_id}
Parameters: company_id
Method: PUT
Description: Update an existing appraisal for a given company..
Endpoint: /api/2.0/companies/{company_id}/appraisals/{appraisal_id}
Parameters: company_id
Method: DELETE
Description: Delete an existing appraisal for a given company..
Endpoint: /api/2.0/companies/{company_id}/appraisals/{appraisal_id}
Parameters: company_id
Method: GET
Description: Get a list of assets for a given company..
Endpoint: /api/2.0/companies/{company_id}/assets
Parameters: company_id
Method: POST
Description: Create a new asset for a given company..
Endpoint: /api/2.0/companies/{company_id}/assets
Parameters: company_id
Method: GET
Description: Get a list of assets for a given company..
Endpoint: /api/2.0/companies/{company_id}/assets/{asset_id}
Parameters: company_id
Method: PUT
Description: Update an existing asset for a given company..
Endpoint: /api/2.0/companies/{company_id}/assets/{asset_id}
Parameters: company_id
Method: DELETE
Description: Delete an existing asset for a given company..
Endpoint: /api/2.0/companies/{company_id}/assets/{asset_id}
Parameters: company_id
Method: GET
Description: Get a list of awards for a given company..
Endpoint: /api/2.0/companies/{company_id}/awards
Parameters: company_id
Method: POST
Description: Create a new award for a given company..
Endpoint: /api/2.0/companies/{company_id}/awards
Parameters: company_id
Method: GET
Description: Get a list of awards for a given company..
Endpoint: /api/2.0/companies/{company_id}/awards/{award_id}
Parameters: company_id
Method: PUT
Description: Update an existing award for a given company..
Endpoint: /api/2.0/companies/{company_id}/awards/{award_id}
Parameters: company_id
Method: DELETE
Description: Delete an existing award for a given company..
Endpoint: /api/2.0/companies/{company_id}/awards/{award_id}
Parameters: company_id
Method: GET
Description: Get a list of background checks for a given company..
Endpoint: /api/2.0/companies/{company_id}/background_checks
Parameters: company_id
Method: POST
Description: Create a new background check for a given company..
Endpoint: /api/2.0/companies/{company_id}/background_checks
Parameters: company_id
Method: GET
Description: Get a list of background checks for a given company..
Endpoint: /api/2.0/companies/{company_id}/background_checks/{background_check_id}
Parameters: company_id
Method: PUT
Description: Update an existing background check for a given company..
Endpoint: /api/2.0/companies/{company_id}/background_checks/{background_check_id}
Parameters: company_id
Method: DELETE
Description: Delete an existing background check for a given company..
Endpoint: /api/2.0/companies/{company_id}/background_checks/{background_check_id}
Parameters: company_id
Method: GET
Description: Get a list of benefits for a given company..
Endpoint: /api/2.0/companies/{company_id}/benefits
Parameters: company_id
Method: POST
Description: Create a new benefit for a given company..
Endpoint: /api/2.0/companies/{company_id}/benefits
Parameters: company_id
Method: GET
Description: Get a list of benefits for a given company..
Endpoint: /api/2.0/companies/{company_id}/benefits/{benefit_id}
Parameters: company_id
Method: PUT
Description: Update an existing benefit for a given company..
Endpoint: /api/2.0/companies/{company_id}/benefits/{benefit_id}
Parameters: company_id
Method: DELETE
Description: Delete an existing benefit for a given company..
Endpoint: /api/2.0/companies/{company_id}/benefits/{benefit_id}
Parameters: company_id
FAQ
Can I integrate the BrightHR API with my existing HR software?
Yes, the BrightHR API is designed to integrate seamlessly with your existing HR software, allowing you to extend its functionality and automate processes.
How do I authenticate with the BrightHR API?
Authentication with the BrightHR API is done using OAuth 2.0. You can obtain an access token by providing your client ID and secret.
What is the rate limit for the BrightHR API?
The BrightHR API has a rate limit of 1000 requests per minute per API key. This limit is in place to ensure the reliability and performance of the API for all users.
Can I use the sandbox account for development testing?
Yes, BrightHR provides a sandbox account that allows you to test your integrations without affecting live data. You can create a sandbox account from the BrightHR developer portal.
How do I handle errors returned by the BrightHR API?
The BrightHR API returns errors in a JSON format. The error response includes a code, message, and documentation URL to help you resolve the issue.