Skip to main content

​
At a glance

  • Availability: Experimental (how to enable).
  • Authentication: Basic auth.
  • Connection: HTTP Basic auth with BAMBOOHR_API_KEY as the username and BAMBOOHR_API_PASSWORD as the password.
  • Provider documentation: Authentication reference.

​
Credentials

Set these per environment. See Connect an integration.

​
Setup

  1. Get a BambooHR account: Use your company’s existing BambooHR account, or start a free trial at https://www.bamboohr.com to get a test company. Note your subdomain - the {company} part of https://{company}.bamboohr.com.
  2. Generate an API key: Log in to BambooHR, click your name in the lower-left corner, and choose API Keys to generate a key. The key inherits the permissions of your user, so time-off and directory access depend on what your user can see.
  3. Store the credentials: Add BAMBOOHR_API_KEY=<your key> and BAMBOOHR_SUBDOMAIN=<your subdomain> to your .env file. The API uses HTTP Basic auth with the API key as the username and any string as the password (BAMBOOHR_API_PASSWORD defaults to x).
  4. Verify access: Run the Get Employee Directory tool with companyDomain set to your subdomain. Requests go to https://{companyDomain}.bamboohr.com/api/v1/.

​
Provider notes

  • Responses default to XML; every tool sends Accept: application/json to get JSON
  • List Time-Off Requests requires both start and end dates (YYYY-MM-DD)
  • Whether you can create or approve time-off requests depends on the permissions of the user who owns the API key
Provider API reference.

​
Tools

​
Verify the connection

Call a read tool such as bamboohr__get_employee_directory with arguments for your account. Confirm that the result comes from the intended account or workspace before enabling write tools.