airbyte/docs/integrations/sources/bamboo-hr.md

BambooHR

This page contains the setup guide and reference information for the BambooHR source connector.

Prerequisites

• BambooHR Account
• BambooHR API key

Setup Guide

Step 1: Set up the BambooHR connector in Airbyte

For Airbyte Cloud:

1. Log into your Airbyte Cloud account.
2. In the left navigation bar, click Sources. In the top-right corner, click + New source.
3. On the Set up the source page, enter the name for the BambooHR connector and select BambooHR from the Source type dropdown.
4. Enter your subdomain. If you access BambooHR at https://mycompany.bamboohr.com, then the subdomain is "mycompany".
5. 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.
6. (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.
7. (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.
8. Toggle Custom Reports Include Default Fields. If true, then the default fields will be returned. If false, then the values defined in Custom Report Fields will be returned.
9. Click Set up source

For Airbyte OSS:

1. Navigate to the Airbyte Open Source dashboard.
2. Set the name for your source.
3. Enter your subdomain. If you access BambooHR at https://mycompany.bamboohr.com, then the subdomain is "mycompany".
4. 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.
5. (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.
6. (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.
7. Toggle Custom Reports Include Default Fields. If true, then the default fields will be returned. If false, then the values defined in Custom Report Fields will be returned.
8. Click Set up source

Supported sync modes

The BambooHR source connector supports the following sync modes:

Feature	Supported?
Full Refresh Sync	Yes
Incremental - Append Sync	Yes
SSL connection	Yes
Namespaces	No

Supported Streams

• Custom Reports

Limitations & Troubleshooting

Expand to see details about BambooHR connector limitations and troubleshooting.

Connector limitations

Rate limiting

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.

Troubleshooting

• Check out common troubleshooting issues for the BambooHR source connector on our Airbyte Forum.

Changelog

Expand to review

Version	Date	Pull Request	Subject
0.9.3	2025-05-24	60660	Update dependencies
0.9.2	2025-05-10	59340	Update dependencies
0.9.1	2025-04-26	58243	Update dependencies
0.9.0	2025-04-14	57587	change how to collect custom fields for custom reports
0.8.3	2025-04-12	57604	Update dependencies
0.8.2	2025-04-05	57190	Update dependencies
0.8.1	2025-03-29	56627	Update dependencies
0.8.0	2025-02-28	54688	Add customers stream
0.7.3	2025-03-22	56137	Update dependencies
0.7.2	2025-03-08	55362	Update dependencies
0.7.1	2025-03-01	54842	Update dependencies
0.7.0	2025-02-27	54701	Add timesheet_entrees stream
0.6.2	2025-02-22	54238	Update dependencies
0.6.1	2025-02-15	53873	Update dependencies
0.6.0	2024-12-02	48759	Fix incremental for TimeOff Requests stream
0.5.9	2025-02-08	53441	Update dependencies
0.5.8	2025-02-01	52909	Update dependencies
0.5.7	2025-01-25	52201	Update dependencies
0.5.6	2025-01-18	51771	Update dependencies
0.5.5	2025-01-11	51263	Update dependencies
0.5.4	2024-12-28	50440	Update dependencies
0.5.3	2024-12-21	50206	Update dependencies
0.5.2	2024-12-14	49543	Update dependencies
0.5.1	2024-12-12	49025	Update dependencies
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