BamBoo HR - Creating an API Link

There are three steps that need to take place within BamBoo HR before we can link to your system.

  1. Determine User Access
  2. Create a new Non-Employee User
  3. Generate an API Key

Determine User Access

Start this process by creating a custom access level that only includes access to the fields needed for the integration. A created API key will have the same amount of access as the user who created it. When first setting up the custom access level, the API key will not have access to information more than necessary.

Create a new Non-Employee User

The reason why you create a new user is that it allows you control who has access via an API.

Go to the specific custom access level and select Add a Non-Employee User from the action menu. You can then enter the first name, last name, and email address of the user. Once you create the user, you can assign them to the custom access level. If necessary, you can create an email alias for the integration to connect to your original email address. For example, your regular email address is pandabear@bamboohr.com, and you want to create a non-employee user with the same address, you can use an email alias such as pandabear+integration@bamboohr.com.


Create the API Key

Using the profile of your new Non-Employee User

Click on the profile picture in the top right corner of your account and select My Devices & API Keys
The access allowed by each API key is based on the access level of the user who generated it. Read more details below on setting up a custom access level for integrations.
Name the API key (we suggest PayMasters) to help you identify and disable it when necessary. Click Generate Key.

The API key will only appear during the process of creation. If you do not copy or

have misplaced the key, you will need to create a new key. Please note that

BambooHR cannot retrieve the key because it is encrypted within our system for

security purposes. Send the key to setups@paymasters.co.nz


Full Admin users and Account Owners can see a list of all API keys in Settings > Account > API Management.
Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.