ContextQMD
Back to Airbyte

BambooHR

docs/integrations/sources/bamboo-hr.md

2.0.010.6 KB
Original Source

BambooHR

<HideInUI>

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

</HideInUI>

Prerequisites

  • BambooHR Account
  • BambooHR API key

Setup Guide

Step 1: Set up the BambooHR connector in Airbyte

<!-- env:cloud -->

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
<!-- /env:cloud --> <!-- env:oss -->

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
<!-- /env:oss --> <HideInUI>

Supported sync modes

The BambooHR source connector supports the following sync modes:

FeatureSupported?
Full Refresh SyncYes
Incremental - Append SyncYes
SSL connectionYes
NamespacesNo

Supported Streams

Limitations & Troubleshooting

<details> <summary> Expand to see details about BambooHR connector limitations and troubleshooting. </summary>

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.
</details>

Changelog

<details> <summary>Expand to review</summary>
VersionDatePull RequestSubject
0.9.32025-05-2460660Update dependencies
0.9.22025-05-1059340Update dependencies
0.9.12025-04-2658243Update dependencies
0.9.02025-04-1457587change how to collect custom fields for custom reports
0.8.32025-04-1257604Update dependencies
0.8.22025-04-0557190Update dependencies
0.8.12025-03-2956627Update dependencies
0.8.02025-02-2854688Add customers stream
0.7.32025-03-2256137Update dependencies
0.7.22025-03-0855362Update dependencies
0.7.12025-03-0154842Update dependencies
0.7.02025-02-2754701Add timesheet_entrees stream
0.6.22025-02-2254238Update dependencies
0.6.12025-02-1553873Update dependencies
0.6.02024-12-0248759Fix incremental for TimeOff Requests stream
0.5.92025-02-0853441Update dependencies
0.5.82025-02-0152909Update dependencies
0.5.72025-01-2552201Update dependencies
0.5.62025-01-1851771Update dependencies
0.5.52025-01-1151263Update dependencies
0.5.42024-12-2850440Update dependencies
0.5.32024-12-2150206Update dependencies
0.5.22024-12-1449543Update dependencies
0.5.12024-12-1249025Update dependencies
0.5.02024-10-2847262Migrate to Manifest-only
0.4.142024-10-2847072Update dependencies
0.4.132024-10-1246842Update dependencies
0.4.122024-10-0546500Update dependencies
0.4.112024-09-2846157Update dependencies
0.4.102024-09-2145766Update dependencies
0.4.92024-09-1445542Update dependencies
0.4.82024-09-0745210Update dependencies
0.4.72024-08-3144978Update dependencies
0.4.62024-08-2444652Update dependencies
0.4.52024-08-1744272Update dependencies
0.4.42024-08-1243851Update dependencies
0.4.32024-08-1043467Update dependencies
0.4.22024-08-0343154Update dependencies
0.4.12024-07-2742779Update dependencies
0.4.02024-07-1841443Add TimeOff Requests stream
0.3.82024-07-2042200Update dependencies
0.3.72024-07-1341780Update dependencies
0.3.62024-07-1041437Update dependencies
0.3.52024-07-0941088Update dependencies
0.3.42024-07-0640818Update dependencies
0.3.32024-06-2540288Update dependencies
0.3.22024-06-2240156Update dependencies
0.3.12024-06-0639201[autopull] Upgrade base image to v1.2.2
0.3.02024-05-2537452Migrate to Low Code
0.2.62024-04-1937124Updating to 0.80.0 CDK
0.2.52024-04-1837124Manage dependencies with Poetry.
0.2.42024-04-1537124Base image migration: remove Dockerfile and use the python-connector-base image
0.2.32024-04-1237124schema descriptions
0.2.22022-09-1617684Fix custom field validation retrieve
0.2.12022-09-1616826Add custom fields validation during check
0.2.02022-03-2411326Add support for Custom Reports endpoint
0.1.02021-08-275054Initial release with Employees API
</details> </HideInUI>