> ## Documentation Index
> Fetch the complete documentation index at: https://domoinc-openapi-sync-dataflows.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# BambooHR Advanced Connector

## Intro

BambooHR consolidates all of your employee information from all of your locations into a single view. You can then access, control, sort, analyze, and take action on the data instantly-from your office, the road or home. The connector enables all those reports to be easily imported into Domo.  For more information about the BambooHR API, visit their website. ([http://www.bamboohr.com/api/documentation/](http://www.bamboohr.com/api/documentation/ "http://www.bamboohr.com/api/documentation/") )

You connect to your BambooHR account in the Data Center. This topic discusses the fields and menus that are specific to the BambooHR connector user interface. General information for adding DataSets, setting update schedules, and editing DataSet information is discussed in [a DataSet Using a Data Connector](/s/article/360042926274 "Adding a DataSet Using a Data Connector").

<table class="mt-responsive-table" data-aura-rendered-by="33:207;a"><tbody><tr><td class="mt-noheading" colspan="1" rowspan="1"><p><b> Primary Use Cases </b></p></td><td class="mt-noheading" colspan="1" rowspan="1"> This connector is appropriate for returning head count, payroll, and recurring reporting. </td></tr><tr><td class="mt-noheading" colspan="1" rowspan="1"><p><b> Primary Metrics </b></p></td><td class="mt-noheading" colspan="1" rowspan="1"><ul><li><p> Employee demographics </p></li><li><p> Salary information </p></li><li><p> Custom reports </p></li></ul></td></tr><tr><td class="mt-noheading" colspan="1" rowspan="1"><p><b> Primary Company Roles </b></p></td><td class="mt-noheading" colspan="1" rowspan="1"><ul><li><p> VP </p></li><li><p> HR director </p></li></ul></td></tr><tr><td class="mt-noheading" colspan="1" rowspan="1"><p><b> Average Implementation Time </b></p></td><td class="mt-noheading" colspan="1" rowspan="1"><p> 20 hours </p></td></tr><tr><td class="mt-noheading" colspan="1" rowspan="1"><p><b> Ease of Use (on a 1-to-10 scale with 1 being easiest) </b></p></td><td class="mt-noheading" colspan="1" rowspan="1"><p> 4 </p></td></tr></tbody></table>

## Best Practices

Do not bring in Personally Identifiable Information (PII) into Domo. Limit those columns and the number of columns by using the Report Fields selector.

## Prerequisites

To connect to your BambooHR account and create a DataSet, you must have the following:

* Your company domain name or the URL of your company BambooHR instance. This is the same URL you use to log in to the BambooHR web interface. For example:

  [https://companydomainname.bamboohr.com](https://companydomainname.bamboohr.com)
* Your BambooHR API key. To generate an API key for a given user, do the following:

  1. Log in to BambooHR and click your name in the upper right hand corner of any page to access the user context menu.
  2. Click **API name** in the upper right hand corner of any page to access the user context menu.
  3. Click **API Keys** to open a page in which you can generate an API key.

     For more information about API keys, see [http://www.bamboohr.com/api/documentation/login.php](http://www.bamboohr.com/api/documentation/login.php "http://www.bamboohr.com/api/documentation/login.php").

## Connecting to Your BambooHR Account

This section enumerates the options in the **Credentials** and **Details** panes in the BambooHR Connector page. The components of the other panes in this page, **Scheduling** and **Name & Describe Your DataSet**, are universal across most connector types and are discussed in greater length in [Adding a DataSet Using a Data Connector](/s/article/360042926274 "Adding a DataSet Using a Data Connector").

### Credentials Pane

This pane contains fields for entering credentials to connect to your BambooHR account. The following table describes what is needed for each field:

<table border="1" cellpadding="1" cellspacing="1" data-aura-rendered-by="33:207;a"><thead><tr><th colspan="1" rowspan="1"><p><span class="s1"> Field </span></p></th><th colspan="1" rowspan="1"><p><span class="s1"> Description </span></p></th></tr></thead><tbody><tr><td colspan="1" rowspan="1"> Company Domain </td><td colspan="1" rowspan="1"> Enter your company domain name or the URL of your company BambooHR instance (such as <span class="mt-font-courier-new"><a href="http://companydomainname.bamboohr.com" rel="noopener" target="_blank"> companydomainname.bamboohr.com </a></span> ). </td></tr><tr><td colspan="1" rowspan="1"> API Key </td><td colspan="1" rowspan="1"> Enter your BambooHR API key. </td></tr></tbody></table>

Once you have entered valid BambooHR credentials, you can use the same account any time you go to create a new BambooHR DataSet. You can manage connector accounts in the **Accounts** tab in the Data Center. For more information about this tab, see [Managing User Accounts for Connectors](/s/article/360042926054 "Managing User Accounts for Connectors").

### Details Pane

This pane contains a primary **Reports** menu and two other menus for configuring your report.

<table border="1" cellpadding="1" cellspacing="1" data-aura-rendered-by="33:207;a"><thead><tr><th colspan="1" rowspan="1"><p> Menu </p></th><th colspan="1" rowspan="1"><p> Description </p></th></tr></thead><tbody><tr><td colspan="1" rowspan="1"><p> Report </p></td><td colspan="1" rowspan="1"><p> Select the BambooHR report you want to run. The following reports are available: </p><table border="1" cellpadding="1" cellspacing="1"><tbody><tr><td colspan="1" rowspan="1"> Employee Data </td><td colspan="1" rowspan="1"> Returns data about employees, such as name, address, email, birthday, gender, ethnicity, department, supervisor, etc. </td></tr><tr><td colspan="1" rowspan="1"> User Data </td><td colspan="1" rowspan="1"> Returns data about users of this account, including first and last name, email, status, etc. </td></tr><tr><td colspan="1" rowspan="1"> Company Report </td><td colspan="1" rowspan="1"> Returns a specified company report. </td></tr></tbody></table></td></tr><tr><td colspan="1" rowspan="1"> Custom Fields </td><td colspan="1" rowspan="1"> Select all fields you want to appear in your report. </td></tr><tr><td colspan="1" rowspan="1"> Company Report ID </td><td colspan="1" rowspan="1"> Enter the ID for the company report you want to retrieve. You can find a company report ID by hovering over the report name on your BambooHR <b> Reports </b> page. </td></tr></tbody></table>

### Other Panes

For information about the remaining sections of the connector interface, including how to configure scheduling, retry, and update options, see [a DataSet Using a Data Connector](/s/article/360042926274 "Adding a DataSet Using a Data Connector").

## Troubleshooting

* Verify the Company Domain Name and API are correct.
* Validate the results by running the report in BambooHR.
* If running a custom report, verify the Report ID is correct.
