BambooHR
This page contains the setup guide and reference information for the BambooHR source connector.
- BambooHR Account
- BambooHR API key
For Airbyte Cloud:
- Log into your Airbyte Cloud account.
- In the left navigation bar, click Sources. In the top-right corner, click + New source.
- On the Set up the source page, enter the name for the BambooHR connector and select BambooHR from the Source type dropdown.
- Enter your
subdomain
. If you access BambooHR at https://mycompany.bamboohr.com, then the subdomain is "mycompany". - Enter your
api_key
. To generate an API key, log in and click your name in the upper right-hand corner of any page to get to the user context menu. If you have sufficient administrator permissions, there will be an "API Keys" option in that menu to go to the page. - (Optional) Enter any
Custom Report Fields
as a comma-separated list of fields to include in your custom reports. Example:firstName,lastName
. If none are listed, then the default fields will be returned. - (Optional) Enter a
Start date
to define the start period for getting data for TimeOff Requests. The default start_date will be 30 days from today's date. - Toggle
Custom Reports Include Default Fields
. If true, then the default fields will be returned. If false, then the values defined inCustom Report Fields
will be returned. - Click Set up source
For Airbyte OSS:
- Navigate to the Airbyte Open Source dashboard.
- Set the name for your source.
- Enter your
subdomain
. If you access BambooHR at https://mycompany.bamboohr.com, then the subdomain is "mycompany". - Enter your
api_key
. To generate an API key, log in and click your name in the upper right-hand corner of any page to get to the user context menu. If you have sufficient administrator permissions, there will be an "API Keys" option in that menu to go to the page. - (Optional) Enter any
Custom Report Fields
as a comma-separated list of fields to include in your custom reports. Example:firstName,lastName
. If none are listed, then the default fields will be returned. - (Optional) Enter a
Start date
to define the start period for getting data for TimeOff Requests. The default start_date will be 30 days from today's date. - Toggle
Custom Reports Include Default Fields
. If true, then the default fields will be returned. If false, then the values defined inCustom Report Fields
will be returned. - Click Set up source
The BambooHR source connector supports the following sync modes:
Feature | Supported? |
---|---|
Full Refresh Sync | Yes |
Incremental - Append Sync | Yes |
SSL connection | Yes |
Namespaces | No |
Expand to see details about BambooHR connector limitations and troubleshooting.
BambooHR has the rate limits, but the connector should not run into API limitations under normal usage.
Please create an issue if you see any rate limit issues that are not automatically retried successfully.
- Check out common troubleshooting issues for the BambooHR source connector on our Airbyte Forum.
Expand to review
Version | Date | Pull Request | Subject |
---|---|---|---|
0.5.0 | 2024-10-28 | 47262 | Migrate to Manifest-only |
0.4.14 | 2024-10-28 | 47072 | Update dependencies |
0.4.13 | 2024-10-12 | 46842 | Update dependencies |
0.4.12 | 2024-10-05 | 46500 | Update dependencies |
0.4.11 | 2024-09-28 | 46157 | Update dependencies |
0.4.10 | 2024-09-21 | 45766 | Update dependencies |
0.4.9 | 2024-09-14 | 45542 | Update dependencies |
0.4.8 | 2024-09-07 | 45210 | Update dependencies |
0.4.7 | 2024-08-31 | 44978 | Update dependencies |
0.4.6 | 2024-08-24 | 44652 | Update dependencies |
0.4.5 | 2024-08-17 | 44272 | Update dependencies |
0.4.4 | 2024-08-12 | 43851 | Update dependencies |
0.4.3 | 2024-08-10 | 43467 | Update dependencies |
0.4.2 | 2024-08-03 | 43154 | Update dependencies |
0.4.1 | 2024-07-27 | 42779 | Update dependencies |
0.4.0 | 2024-07-18 | 41443 | Add TimeOff Requests stream |
0.3.8 | 2024-07-20 | 42200 | Update dependencies |
0.3.7 | 2024-07-13 | 41780 | Update dependencies |
0.3.6 | 2024-07-10 | 41437 | Update dependencies |
0.3.5 | 2024-07-09 | 41088 | Update dependencies |
0.3.4 | 2024-07-06 | 40818 | Update dependencies |
0.3.3 | 2024-06-25 | 40288 | Update dependencies |
0.3.2 | 2024-06-22 | 40156 | Update dependencies |
0.3.1 | 2024-06-06 | 39201 | [autopull] Upgrade base image to v1.2.2 |
0.3.0 | 2024-05-25 | 37452 | Migrate to Low Code |
0.2.6 | 2024-04-19 | 37124 | Updating to 0.80.0 CDK |
0.2.5 | 2024-04-18 | 37124 | Manage dependencies with Poetry. |
0.2.4 | 2024-04-15 | 37124 | Base image migration: remove Dockerfile and use the python-connector-base image |
0.2.3 | 2024-04-12 | 37124 | schema descriptions |
0.2.2 | 2022-09-16 | 17684 | Fix custom field validation retrieve |
0.2.1 | 2022-09-16 | 16826 | Add custom fields validation during check |
0.2.0 | 2022-03-24 | 11326 | Add support for Custom Reports endpoint |
0.1.0 | 2021-08-27 | 5054 | Initial release with Employees API |