API Data Provider - Online Help

Connecting to BambooHR

BambooHR uses token authentication to control access to the API.

Using Token Authentication

In order to authenticate to BambooHR, you'll need to provide your API Key. To generate an API key, you should 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 permissions, there will be an "API Keys" option in that menu to go to the page, where you can create a new API Key. Additionally, you will need to set the Domain, found in the domain name of your BambooHR account. For example if your BambooHR account is acmeinc.bamboohr.com, then the Domain should be 'acmeinc'. Set both the API Key and Domain in the ProfileSettings property to connect.

Example connection string

Profile=C:\profiles\BambooHR.apip;ProfileSettings='Domain=acmeinc;APIKey=your_api_key';

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.


Property Description
APIKey Your BambooHR API Key.
Domain The Domain for the BambooHR account.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839.0