> For the complete documentation index, see [llms.txt](https://resmocom.gitbook.io/product/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://resmocom.gitbook.io/product/integrations/bamboohr-integration.md).

# BambooHR Integration

## Resmo + BambooHR Integration Fundamentals

<figure><img src="/files/dRnfUUmB51NrFOITdbDz" alt=""><figcaption></figcaption></figure>

### What does Resmo offer to BambooHR users?

* Collect your directory assets like users, employees, and company files from your BambooHR account (not the content of files) to create a complete asset inventory.
* Query your BambooHR users, employees, and files with Resmo's flexible SQL engine.
* Set up rules to automate your resources' security and compliance evaluation.
* Get timely notifications based on BambooHR resource configurations.

### How does the integration work?

Once you sign up to Resmo, you can easily integrate your account with BambooHR using the subdomain of your account and API Key.

* The **subdomain** can be obtained as follows: "mycompany" is the subdomain of <https://mycompany.bamboohr.com>.
* The **API Key** can be created from\
  <https://documentation.bamboohr.com/docs#authentication>
  * As described in the BambooHR documentation, the API key will be created with the permissions of the associated user. This means the user must have sufficient permissions to create an API key, list users' metadata, and list company files. (File content will not be collected.)
  * You can select company file categories to collect. Resmo will collect only selected categories.
  * Creating an API Key with the separate user that was created for the integration with its access requirements is recommended.

#### Available resources

{% embed url="<https://resources.resmo.com/bamboohr>" %}

## Integration Walkthrough

### How to install

1. Go to your Integrations page on Resmo and select BambooHR.
2. Click the Add Integration button at the bottom right corner of the opening modal.
3. On a new tab, go to your BambooHR account and create an API Key by following the instructions from <https://documentation.bamboohr.com/docs#authentication>

<figure><img src="/files/LVoisvI5coXEZBAZOEj9" alt=""><figcaption></figcaption></figure>

4. Copy and paste the API Key on the integration screen’s API Token field.
5. Enter the subdomain of your BambooHR account on the integration screen’s Subdomain field.
6. Hit the Create button, and you are ready to run queries.

### How to uninstall

1. Go to Integrations -> BambooHR.
2. From there, navigate to the Connected Integrations.&#x20;
3. Select the BambooHR integration you want to uninstall.
4. To temporarily pause the integration, click the Disable button from the top right. To permanently remove it, click the Delete button.


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://resmocom.gitbook.io/product/integrations/bamboohr-integration.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
