Prerequisites
- An active BambooHR account in the target company.
- Permission in BambooHR to view the employees, time-off records, and reports the agent or workflow requires.
- A personal BambooHR API key — go to My Info → API Keys in BambooHR, generate a key, and copy it immediately.
- The company subdomain from your BambooHR login URL. For
https://acme.bamboohr.com, the subdomain isacmeonly — not the full URL.
Setup
1
Generate a BambooHR API key
Sign in to BambooHR as the dedicated user. Go to My Info → API Keys, generate a personal API key, and copy it immediately. Note the company subdomain from the login URL.
2
Open an agent or workflow
Open an agent and add the BambooHR toolkit under Toolkits, or add a BambooHR step to a workflow.
3
Create a saved connection
In the BambooHR step, choose + New under Select saved connection. Enter a Connection Name, the Company Subdomain (letters, digits, and hyphens only — not the full URL), and the API Key. Save the connection.
4
Enable only the tools you need
Start with read-only actions: Find Employee, Who’s Out, and Get Time Off Balances. Enable write actions only after access and confirmation policy are approved.
5
Test with a safe read action
Run Who’s Out without any date inputs to confirm the connection. An empty list is a valid result when nobody is out.
Available tools
Employees
Time Off
Reports
Advanced
Use cases
- Answer “who is out this week?” by running Who’s Out with the current week’s date range.
- Look up an employee by name or email and return their manager, title, and department.
- Check an employee’s remaining PTO balance before submitting a time-off request on their behalf.
- Run a custom report to pull a specific set of employee fields for a downstream workflow step.
- List pending time-off requests in a date range and summarize them for a manager.