bamboohr

What this skill does

# BambooHR

BambooHR is an HRIS platform that helps small and medium-sized businesses manage employee data, payroll, benefits, and other HR functions. It's used by HR professionals and managers to streamline HR processes and improve employee experience.

Official docs: https://documentation.bamboohr.com/docs

## BambooHR Overview

- **Employee**
  - **Employee Directory**
- **Time Off**
- **Report**
- **Compensation**
- **Goal**
- **Performance**
- **Training Course**
- **Applicant**
- **Offer**
- **Task**
- **Checklist**
- **Custom Report**
- **Table**
- **List**
- **Dashboard**
- **Integration**
- **Approval**
- **File**
- **Email**
- **Note**
- **Audit Trail**
- **User**
- **Settings**
- **Alert**
- **Form**
- **Workflow**
- **Event**
- **Policy**
- **Document**
- **Update**
- **Change Log**
- **Comment**
- **History**
- **Log**
- **Subscription**
- **Role**
- **Group**
- **Access Level**
- **Permission**
- **Category**
- **Field**
- **Tab**
- **Section**
- **Item**
- **Request**
- **Assignment**
- **Activity**
- **Reminder**
- **Notification**
- **Survey**
- **Question**
- **Answer**
- **Signature**
- **Device**
- **Location**
- **Department**
- **Division**
- **Subsidiary**

Use action names and parameters as needed.

## Working with BambooHR

This skill uses the Membrane CLI to interact with BambooHR. Membrane handles authentication and credentials refresh automatically — so you can focus on the integration logic rather than auth plumbing.

### Install the CLI

Install the Membrane CLI so you can run `membrane` from the terminal:

```bash
npm install -g @membranehq/cli@latest
```

### Authentication

```bash
membrane login --tenant --clientName=<agentType>
```

This will either open a browser for authentication or print an authorization URL to the console, depending on whether interactive mode is available.

**Headless environments:** The command will print an authorization URL. Ask the user to open it in a browser. When they see a code after completing login, finish with:

```bash
membrane login complete <code>
```

Add `--json` to any command for machine-readable JSON output.

**Agent Types** : claude, openclaw, codex, warp, windsurf, etc. Those will be used to adjust tooling to be used best with your harness

### Connecting to BambooHR

Use `membrane connection ensure` to find or create a connection by app URL or domain:

```bash
membrane connection ensure "" --json
```
The user completes authentication in the browser. The output contains the new connection id.

This is the fastest way to get a connection. The URL is normalized to a domain and matched against known apps. If no app is found, one is created and a connector is built automatically.

If the returned connection has `state: "READY"`, skip to **Step 2**.

#### 1b. Wait for the connection to be ready

If the connection is in `BUILDING` state, poll until it's ready:

```bash
npx @membranehq/cli connection get <id> --wait --json
```

The `--wait` flag long-polls (up to `--timeout` seconds, default 30) until the state changes. Keep polling until `state` is no longer `BUILDING`.

The resulting state tells you what to do next:

- **`READY`** — connection is fully set up. Skip to **Step 2**.
- **`CLIENT_ACTION_REQUIRED`** — the user or agent needs to do something. The `clientAction` object describes the required action:
  - `clientAction.type` — the kind of action needed:
    - `"connect"` — user needs to authenticate (OAuth, API key, etc.). This covers initial authentication and re-authentication for disconnected connections.
    - `"provide-input"` — more information is needed (e.g. which app to connect to).
  - `clientAction.description` — human-readable explanation of what's needed.
  - `clientAction.uiUrl` (optional) — URL to a pre-built UI where the user can complete the action. Show this to the user when present.
  - `clientAction.agentInstructions` (optional) — instructions for the AI agent on how to proceed programmatically.

  After the user completes the action (e.g. authenticates in the browser), poll again with `membrane connection get <id> --json` to check if the state moved to `READY`.

- **`CONFIGURATION_ERROR`** or **`SETUP_FAILED`** — something went wrong. Check the `error` field for details.

### Searching for actions

Search using a natural language description of what you want to do:

```bash
membrane action list --connectionId=CONNECTION_ID --intent "QUERY" --limit 10 --json
```

You should always search for actions in the context of a specific connection.

Each result includes `id`, `name`, `description`, `inputSchema` (what parameters the action accepts), and `outputSchema` (what it returns).

## Popular actions

| Name | Key | Description |
| --- | --- | --- |
| Get Time Off Policies | get-time-off-policies | Retrieves time off policies configured in the company |
| Get Employee Trainings | get-employee-trainings | Retrieves training records for an employee |
| Get Training Types | get-training-types | Retrieves the list of training types configured in BambooHR |
| Get Employee Dependents | get-employee-dependents | Retrieves employee dependents, optionally filtered by employee ID |
| Get Employee Table Rows | get-employee-table-rows | Retrieves tabular data rows for an employee (e.g., job history, compensation, emergency contacts) |
| Run Custom Report | run-custom-report | Runs a custom report with specified fields and filters |
| Get Job Applications | get-job-applications | Retrieves job applications from the applicant tracking system |
| Get Job Openings | get-job-openings | Retrieves job summaries/openings from the applicant tracking system |
| Get Fields | get-fields | Retrieves the list of available fields in BambooHR |
| Get Users | get-users | Retrieves the list of users (admin accounts) in BambooHR |
| Get Company Information | get-company-information | Retrieves company information from BambooHR |
| Get Time Off Types | get-time-off-types | Retrieves the list of time off types configured in the company |
| Get Who's Out | get-whos-out | Retrieves a list of employees who are out during a specified date range |
| Create Time Off Request | create-time-off-request | Creates a new time off request for an employee |
| Get Time Off Requests | get-time-off-requests | Retrieves time off requests with optional filtering by employee, date range, status, and type |
| Get Employee Directory | get-employee-directory | Retrieves a company directory of employees |
| Update Employee | update-employee | Updates an existing employee's information in BambooHR |
| Create Employee | create-employee | Creates a new employee in BambooHR |
| Get Employee | get-employee | Retrieves a single employee by their ID with specified fields |
| List Employees | list-employees | Retrieves a list of employees with optional filtering, sorting, and pagination |

### Running actions

```bash
membrane action run <actionId> --connectionId=CONNECTION_ID --json
```

To pass JSON parameters:

```bash
membrane action run <actionId> --connectionId=CONNECTION_ID --input '{"key": "value"}' --json
```

The result is in the `output` field of the response.


### Proxy requests

When the available actions don't cover your use case, you can send requests directly to the BambooHR API through Membrane's proxy. Membrane automatically appends the base URL to the path you provide and injects the correct authentication headers — including transparent credential refresh if they expire.

```bash
membrane request CONNECTION_ID /path/to/endpoint
```

Common options:

| Flag | Description |
|------|-------------|
| `-X, --method` | HTTP method (GET, POST, PUT, PATCH, DELETE). Defaults to GET |
| `-H, --header` | Add a request header (repeatable), e.g. `-H "Accept: application/json"` |
| `-d, --data` | Request body (string) |
| `--json` | Shorthand to send a JSON body and set `Content-Type: application/json` |
| `--rawData` | Send the body as-is without any processing |
| `--query` | Query-string parameter (repeat