BambooHR source

Overview

The BambooHR source connector lets you connect to the BambooHR API using an API key and your company subdomain.

Setup

Prerequisites

• A BambooHR account with permission to create or access an API key.
• Your BambooHR company subdomain (the {company} part of https://{company}.bamboohr.com).

Create an API key in BambooHR

In BambooHR, generate an API key for the user you want the connector to authenticate as. BambooHR API keys are used with HTTP Basic Auth.

Authentication

This connector authenticates with:

• Username: your BambooHR API key
• Password: any value (the connector uses a placeholder)

The connector validates credentials by calling the BambooHR API endpoint:

• GET https://{company}.bamboohr.com/api/v1/meta/users

Configuration

Field	Type	Required	Description
company_domain	string	✅	Your BambooHR company subdomain (plain subdomain only). Example: acme for https://acme.bamboohr.com. Do not include http(s)://, slashes, or .bamboohr.com.
api_key	string	✅	BambooHR API key used for authentication.

Company domain formatting rules

company_domain must be a plain subdomain. The connector will reject values that include characters typical of full URLs (such as /, :, or @).

Valid examples:

• acme
• my-company

Invalid examples:

• https://acme.bamboohr.com
• acme.bamboohr.com
• acme/
• acme:443

Streams

This connector is currently in development and does not yet extract any streams.

Limitations

• Extraction not available yet: the connector can validate credentials, but data extraction is not implemented.