BambooHR Tool
Read the BambooHR employee directory, employees, and time-off data via the BambooHR API.
Tool ID
bamboohr-employees
Credential Required
Yes — an API-key credential (auth mode basic). The credential's secret is your BambooHR API key (generate one from your BambooHR account under API Keys). It is sent as the HTTP Basic username with an empty password — the token-as-username form BambooHR expects — so leave the credential's login blank (if a login is set, the tool sends login:key instead). The vault's password/secret fields are accepted as fallbacks for apiKey; a task-input apiKey is honoured as a last-resort fallback for older tasks.
The base URL is fixed: https://api.bamboohr.com/api/gateway.php/{company}/v1, with {company} filled from the task's company input (your BambooHR subdomain).
Credential Properties
| Property | Type | Default | Description |
|---|---|---|---|
apiKey |
string | — | Required. API key / token used to authenticate |
Operations
1. employee_directory — Employee directory
Reads the company employee directory.
Calls GET /employees/directory.
Properties:
| Property | Type | Default | Description |
|---|---|---|---|
company |
string | — | Required. Your BambooHR company subdomain (the {company} in api.bamboohr.com/api/gateway.php/{company}/v1) |
query |
string | — | Optional query params as a JSON object string |
Published Outputs:
- result — the JSON response body
- status — HTTP status code
2. get_employee — Get one employee
Reads a single employee's fields by id.
Calls GET /employees/{id}.
Properties:
| Property | Type | Default | Description |
|---|---|---|---|
company |
string | — | Required. Your BambooHR company subdomain |
id |
string | — | Required. Employee id |
query |
string | — | Needs a fields list, e.g. {"fields": "firstName,lastName,jobTitle,department,workEmail"} |
Published Outputs:
- result — the JSON response body
- status — HTTP status code
3. whos_out — Who's out
Reads who is out on time off.
Calls GET /time_off/whos_out.
Properties:
| Property | Type | Default | Description |
|---|---|---|---|
company |
string | — | Required. Your BambooHR company subdomain |
query |
string | — | Accepts start/end dates, e.g. {"start": "2026-07-01", "end": "2026-07-31"} |
Published Outputs:
- result — the JSON response body
- status — HTTP status code
4. list_time_off_requests — List time-off requests
Reads time-off requests.
Calls GET /time_off/requests.
Properties:
| Property | Type | Default | Description |
|---|---|---|---|
company |
string | — | Required. Your BambooHR company subdomain |
query |
string | — | Accepts start/end dates, e.g. {"start": "2026-07-01", "end": "2026-07-31"} |
Published Outputs:
- result — the JSON response body
- status — HTTP status code
Self-Contained JAR
The jar bundles all runtime dependencies; only intouch-tool-api is provided by the server.
Publishes
The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.
completeoperationresultstatuswarning