Overview

To authenticate BambooHR using an API Key, you will need to provide the following information:

• Subdomain
• API key

This guide will walk you through finding or creating those credentials within BambooHR.

Prerequisites

Please ensure you fulfill all the requirements to set up the integration:

You have Full-Admin access in your company's BambooHR instance, or someone has shared their access with you

• A Custom Access Level in BambooHR that you can update permissions for. Steps 1 and 2 below set it up so that 5Mins can read the data needed to provision users - compensation, pay, and time off data will not be accessible.

Instructions

Step 1: Edit the access level for other employees

1. Click the settings icon in the top right

2. Click Access Levels

3. Click on the access level you want to edit and hit Access Level Settings

4. Select "ALL EMPLOYEES" for whom this access level can access the information.

5. Under the Personal section, enable View access for the following:

   • Basic Information:
     • Status
     • Employee Number
     • First Name
     • Last Name
     • Preferred Name
   • Address:
     • Address Line 1
     • Address Line 2
     • City
     • State
     • Zip Code
     • Country
   • Contact:
     • Mobile Phone
     • Work Phone
     • Work Email
     • Home Email

6. Under the Job section, enable View access for the following:

   • Hire Date
   • Original Hire Date
   • Direct Reports
   • Team
   • Employment Status
     • Employment Status Date
     • Employment Status
     • Termination Type
   • Job Information
     • Job Title
     • Department
     • Division
     • Location
     • Job Information Date
     • Reporting To

7. (Optional for Dependents data) Under the Benefits section, enable View access for the following:

   • Dependents - all relevant fields for your use case

Step 2: Edit the access level for your information

1. Select the "See About Themselves" option

2. Choose "Yes, Allow Access" for the "Should Employees be able to see their own information?" question

3. Choose "Full Access" for "Which Access Level should apply?"

   • This means that the BambooHR Employee with this custom access level can see the same information for themselves.

Step 3: Add your BambooHR subdomain to the linking flow

For example, if you sign in at "acme.bamboohr.com", add acme

Do not enter the full "acme.bamboohr.com"

Step 4: Find your BambooHR API key

1. Click on your name in the upper right-hand corner and in the user context menu click on API Keys

   

2. Click Add New Key in the upper left corner

   

3. Input an API Key Name, and then click Generate Key

   

4. Copy the API key that appears, and add it to the linking flow

   

Step 5: Click on Bamboo Integration link given by 5Mins AI

Step 6: Select BambooHR Integration option

Step 7: Enter the subdomain

Step 8: Enter the API Keys that you generated earlier

That’s it! Integration is complete.