BambooHR uses an API key to grant access. This has the same permissions as the user who creates the key.
For this reason we recommend creating a Custom Access Level, and creating and assigning a new user account to this level.
This means you can securely restrict the BambooHR data fields that Trelica has access to.
Create a Custom Access Level
Click on the gear icon in the top-right corner of the page to go to the Settings page.
Choose Access Levels, click the + button, and choose Custom Access Level:
Enter a name for your Custom Access Level (e.g. Trelica Integration Permissions) and a description.
Click Next Step.
This step is called What Can People with this Access Level Can Do - you don't need to change anything here, so just click Next Step again.
On the What Can People with this Access Level See step you can set the specific permissions to grant to Trelica.
Configure the following fields as View Only:
- Basic Info > Status
- Basic Info > Employee #
- Basic Info > First Name
- Basic Info > Last Name
- Contact > Work Email
- Contact > Home Email (this is important for onboarding)
- Hire Date
- Employment Status > Employment Status: Date
- Employment Status > Employment Status
- Job Information > Job Title
- Job Information > Department
- Job Information > Division
- Job Information > Location
- Job Information > Reporting to
You will also need to complete the See About Themselves tab:
When you are done, click Save and Finish
Create a non-Employee user
Go back to the Settings page (click the gear icon in the top-right corner of the page).
Choose Access Levels and select the Custom Access Level you just created (likely called Trelica Integration Permissions).
Click the small gear icon dropdown and choose Add a Non-Employee BambooHR User.
Now enter a name (e.g. First name Trelica, and Last name Integration).
Enter an email address that you have access to.
If you use Google for your company email, you can enter a special email using a "+" character, as a separator. e.g.
This will be sent to firstname.lastname@example.org as normal, but lets you use a distinctive email for the integration user account.
Set the Access Level dropdown to the Custom Access Level you just created (likely called Trelica Integration Permissions).
Once the user has been created you will receive a welcome email in the inbox of the email address you just entered.
Follow the steps in this email to create a password for the user.
Create an API key
Sign-in to BambooHR with the email and password you just created.
Click on your profile icon in the top-right and choose API Keys.
In the API Keys screen, choose Add a new key.
Copy this API key and paste it into the API key field when you connect to BambooHR from Trelica.