bamboohr-install-auth

name	bamboohr-install-auth
description	Install and configure BambooHR API authentication with HTTP Basic Auth. Use when setting up a new BambooHR integration, configuring API keys, or initializing BambooHR REST API access in your project. Trigger with phrases like "install bamboohr", "setup bamboohr", "bamboohr auth", "configure bamboohr API key", "bamboohr credentials".
allowed-tools	Read, Write, Edit, Bash(npm:*), Bash(pip:*), Bash(curl:*), Grep
version	1.4.0
license	MIT
author	Jeremy Longshore <[e-mail]>
tags	["saas","hr","bamboohr","authentication"]
compatibility	Designed for Claude Code

BambooHR Install & Auth

Overview

Set up BambooHR REST API authentication. BambooHR uses HTTP Basic Authentication — your API key is the username, and the password can be any arbitrary string (typically x).

Base URL pattern:

https://api.bamboohr.com/api/gateway.php/{companyDomain}/v1/

Where {companyDomain} is your BambooHR subdomain (e.g., acmecorp from acmecorp.bamboohr.com).

Prerequisites

• Node.js 18+ or Python 3.10+
• BambooHR account with API access enabled
• API key generated from BambooHR (Account > API Keys)
• Company subdomain from your BambooHR URL

Instructions

Step 1: Generate an API Key

1. Log in to BambooHR at https://{companyDomain}.bamboohr.com
2. Click your profile icon > API Keys
3. Click Add New Key, give it a descriptive name
4. Copy the key immediately — it is only shown once

Step 2: Configure Environment Variables

# Required
export BAMBOOHR_API_KEY="your-api-key-here"
export BAMBOOHR_COMPANY_DOMAIN="yourcompany"

# Create .env file for local development
cat > .env << 'EOF'
BAMBOOHR_API_KEY=your-api-key-here
BAMBOOHR_COMPANY_DOMAIN=yourcompany
EOF

# IMPORTANT: Add to .gitignore
echo '.env' >> .gitignore
echo '.env.local' >> .gitignore

Step 3: Install HTTP Client

# Node.js — no BambooHR-specific SDK needed; use fetch or axios
npm install dotenv

# Python
pip install requests python-dotenv

Step 4: Verify Connection

TypeScript / Node.js:

import 'dotenv/config';

  = process..!;
  = process..!;
  = ;


 headers = {
  : ,
  : ,
};


 res =  (, { headers });

 (res.) {
   data =  res.();
  .();
}  {
  .();
   errHeader = res..();
   (errHeader) .();
}