> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/bamboohr.md).

# BambooHR

BambooHR is an HR platform. Read your employee directory, employee profiles, time-off requests, who's out, and company reports from your AI workflows.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| BambooHR  | Credentials    |

#### BambooHR

Connect to BambooHR with a company subdomain and API key to read employee and time-off data.

**Set up in BambooHR**

1. Prepare the BambooHR account or service that the workflow will access. Grant access to the required resources and operations.
2. **API Key:** A BambooHR API key. Generate one from your BambooHR account under 'API Keys' in the profile menu.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **BambooHR**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field     | Required | What to enter                                                                                                                                                                                      |
| ----------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Company Subdomain | Yes      | Your BambooHR company subdomain: the '\<company>' in https\://\<company>.bamboohr.com.                                                                                                             |
| API Key           | Yes      | A BambooHR API key. Generate one from your BambooHR account under 'API Keys' in the profile menu. [Provider instructions](https://documentation.bamboohr.com/docs/getting-started#authentication). |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **BambooHR** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Get Employee Directory

List the employees in your BambooHR company directory.

**Inputs**

| Field  | Type    | Required | Description                                                                            |
| ------ | ------- | -------- | -------------------------------------------------------------------------------------- |
| Offset | integer | No       | Skip this many employees; pass a previous call's next\_offset. Minimum: 0. Default: 0. |
| Limit  | integer | No       | Maximum number of employees to return. Minimum: 1. Maximum: 500. Default: 100.         |

**Outputs**

| Field       | Type        | Description                                                  |
| ----------- | ----------- | ------------------------------------------------------------ |
| Employees   | dict\_array | The employees in the company directory.                      |
| Fields      | dict\_array | The field descriptors present on each employee row.          |
| Count       | integer     | Number of employees returned (may be capped; see has\_more). |
| Has More    | boolean     | True if more employees exist beyond the returned set.        |
| Next Offset | integer     | Pass this back as Offset to continue, if present.            |

#### Get Employee

Fetch a single BambooHR employee's profile fields by id.

**Inputs**

| Field    | Type            | Required | Description                                                                                                                                                                         |
| -------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Employee | select (string) | Yes      | Pick an employee from the directory, or paste an employee id. Options load from the selected connection.                                                                            |
| Fields   | string          | No       | Comma-separated list of fields to return. Default: firstName,lastName,displayName,jobTitle,department,division,location,workEmail,mobilePhone,workPhone,supervisor,hireDate,status. |

**Outputs**

| Field        | Type   | Description                                    |
| ------------ | ------ | ---------------------------------------------- |
| Employee     | dict   | The employee object with the requested fields. |
| Employee ID  | string | The employee id.                               |
| Display Name | string | The employee's display name, when available.   |

#### Get Time-Off Requests

List BambooHR time-off requests in a date window, by employee or status.

**Inputs**

| Field      | Type            | Required | Description                                                                                  |
| ---------- | --------------- | -------- | -------------------------------------------------------------------------------------------- |
| Employee   | select (string) | No       | Optional employee to filter requests by. Options load from the selected connection.          |
| Start Date | date            | Yes      | Start of the window (YYYY-MM-DD). BambooHR requires both dates.                              |
| End Date   | date            | Yes      | End of the window (YYYY-MM-DD). BambooHR requires both dates.                                |
| Status     | select (string) | No       | Optional status filter. Available values: Approved, Denied, Superseded, Requested, Canceled. |
| Offset     | integer         | No       | Skip this many requests; pass a previous call's next\_offset. Minimum: 0. Default: 0.        |
| Limit      | integer         | No       | Maximum number of requests to return. Minimum: 1. Maximum: 500. Default: 100.                |

**Outputs**

| Field       | Type        | Description                                                 |
| ----------- | ----------- | ----------------------------------------------------------- |
| Requests    | dict\_array | The matching time-off requests.                             |
| Count       | integer     | Number of requests returned (may be capped; see has\_more). |
| Has More    | boolean     | True if more requests exist beyond the returned set.        |
| Next Offset | integer     | Pass this back as Offset to continue, if present.           |

#### Get Who's Out

See who is out of office (time-off and holidays) in a date window.

**Inputs**

| Field      | Type    | Required | Description                                                                          |
| ---------- | ------- | -------- | ------------------------------------------------------------------------------------ |
| Start Date | date    | No       | Start of the window (YYYY-MM-DD). Defaults to today.                                 |
| End Date   | date    | No       | End of the window (YYYY-MM-DD). Defaults to 14 days out.                             |
| Offset     | integer | No       | Skip this many entries; pass a previous call's next\_offset. Minimum: 0. Default: 0. |
| Limit      | integer | No       | Maximum number of entries to return. Minimum: 1. Maximum: 500. Default: 100.         |

**Outputs**

| Field       | Type        | Description                                                     |
| ----------- | ----------- | --------------------------------------------------------------- |
| Entries     | dict\_array | Who's out: time-off entries and company holidays in the window. |
| Count       | integer     | Number of entries returned (may be capped; see has\_more).      |
| Has More    | boolean     | True if more entries exist beyond the returned set.             |
| Next Offset | integer     | Pass this back as Offset to continue, if present.               |

#### Get Custom Report

Run an existing BambooHR custom report and return its rows as JSON.

**Inputs**

| Field     | Type    | Required | Description                                                                      |
| --------- | ------- | -------- | -------------------------------------------------------------------------------- |
| Report ID | string  | Yes      | The saved custom report to run.                                                  |
| Page      | integer | No       | Continue from a page number returned by an earlier call. Minimum: 1. Default: 1. |
| Limit     | integer | No       | Rows per page. Minimum: 1. Maximum: 500. Default: 100.                           |

**Outputs**

| Field         | Type        | Description                                               |
| ------------- | ----------- | --------------------------------------------------------- |
| Rows          | dict\_array | The report rows (one object per employee).                |
| Fields        | dict\_array | The report columns, in the order the report shows them.   |
| Count         | integer     | Number of rows on this page.                              |
| Total Records | integer     | Rows the report produced across all pages, when reported. |
| Has More      | boolean     | True if BambooHR reported more rows on later pages.       |
| Next Page     | integer     | Pass this back as Page to continue, if present.           |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/bamboohr.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
