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:
- 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. - 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. - 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
Supported sync modes
The BambooHR source connector supports the following sync modes:
Feature | Supported? |
---|---|
Full Refresh Sync | Yes |
Incremental - Append Sync | No |
SSL connection | Yes |
Namespaces | No |
Supported Streams
Limitations & Troubleshooting
Expand to see details about BambooHR connector limitations and troubleshooting.
Reference
Config fields reference
Field
Type
Property name
string
api_key
string
subdomain
string
custom_reports_fields
boolean
custom_reports_include_default_fields