> ## Documentation Index
> Fetch the complete documentation index at: https://docs.duvo.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# BambooHR

BambooHR is an HR platform for employee records, time off, documents, and HR reporting. Connecting BambooHR to Duvo lets your agents read and update HR data directly from your BambooHR account.

## Setup

<Steps>
  <Step title="Confirm prerequisites" icon="circle-check">
    <Check>A BambooHR account.</Check>
    <Check>The company subdomain from your BambooHR URL. For example, if you sign in at `https://acme.bamboohr.com`, your subdomain is `acme`.</Check>
    <Check>A BambooHR API key. In BambooHR, open your user menu and select **API Keys**. If the option is not available, ask a BambooHR admin to create a key or enable access for the right user.</Check>
    <Check>A dedicated service account is recommended when possible, so access is not tied to an individual employee account.</Check>

    <Tip>
      New to the BambooHR API? Follow [BambooHR's Getting Started With The API guide](https://documentation.bamboohr.com/docs/getting-started) for company domains, API keys, authentication, and permissions.
    </Tip>
  </Step>

  <Step title="Grant the required permissions" icon="key">
    BambooHR API keys use the same access level as the user who created the key. Make sure that user can access the employees, fields, reports, time off data, and file sections your agents need.

    For write workflows, the user must also have permission to create or update the relevant records in BambooHR, such as employee profile fields, time off requests, or employee files.

    <Warning>
      The API key inherits the creating user's access level, so it can reach everything that user can. Use a dedicated service account scoped to only the records your agents need.
    </Warning>
  </Step>

  <Step title="Add the connection in Duvo" icon="plug">
    On the [Connections page](https://app.duvo.ai/integrations), open BambooHR and fill in these fields:

    <ParamField body="Company Subdomain" type="string" required>
      The subdomain in your BambooHR URL. For `https://acme.bamboohr.com`, enter `acme`.
    </ParamField>

    <ParamField body="API Key" type="string" required>
      The BambooHR API key generated from the user menu or admin API key settings. The key inherits that user's access level.
    </ParamField>
  </Step>
</Steps>

<AccordionGroup>
  <Accordion title="Third-party documentation" icon="book">
    * [BambooHR Getting Started With The API](https://documentation.bamboohr.com/docs/getting-started) - BambooHR's guide to company domains, API keys, authentication, and permissions.
    * [BambooHR Technical Overview](https://documentation.bamboohr.com/docs/api-details) - request format, response codes, and API behavior.
    * [BambooHR Admin API Keys Settings](https://www.bamboohr.com/product-updates/admin-api-keys-settings) - BambooHR's account-level API key management overview.
  </Accordion>
</AccordionGroup>

## Capabilities

* **Manage employee records** - list employees, find individual employee profiles, create new employees, update employee fields, and identify records changed since a prior sync.
* **Use directory and field metadata** - read the company directory and discover available BambooHR fields before building reports or updates.
* **Work with time off** - list who is out, review time off requests, create new requests, check balances, list time off types, and update request status when the API key has approval access.
* **Access HR files** - list employee and company file categories, download files, and upload employee documents subject to BambooHR permissions and file limits.
* **Run reports and datasets** - list saved reports, run custom reports, discover dataset fields, and export larger results for agents to analyze.

## Key Benefits

* **Live HR data in workflows** - agents can use current BambooHR records instead of relying on manual exports.
* **Permission-scoped access** - BambooHR controls what Duvo can read or change through the API key user's access level.
* **Fewer manual HR handoffs** - agents can look up employees, update records, attach files, and prepare time off information without switching tools.
* **Better operational reporting** - saved reports and dataset queries help agents pull HR data into recurring summaries, audits, and exception checks.

## Works Well With

<CardGroup cols={3}>
  <Card title="Google Sheets" icon="https://mintcdn.com/duvo-d8027998/O3tlM6eCuFk2uJpN/images/connections/google-sheets.svg?fit=max&auto=format&n=O3tlM6eCuFk2uJpN&q=85&s=0ef8d55e05c34e7a4a618933bdf0ceb3" href="/user-guide/connections/available-connections/google-sheets" width="24" height="24" data-path="images/connections/google-sheets.svg">
    Export employee lists, time off summaries, or report results into spreadsheets for review.
  </Card>

  <Card title="Microsoft Excel" icon="https://mintcdn.com/duvo-d8027998/O3tlM6eCuFk2uJpN/images/connections/excel.svg?fit=max&auto=format&n=O3tlM6eCuFk2uJpN&q=85&s=986599d60d09acee47293fda2b62df99" href="/user-guide/connections/available-connections/microsoft-excel" width="2290" height="2130" data-path="images/connections/excel.svg">
    Export employee lists, time off summaries, or report results into spreadsheets for review.
  </Card>

  <Card title="Gmail" icon="https://mintcdn.com/duvo-d8027998/O3tlM6eCuFk2uJpN/images/connections/gmail.svg?fit=max&auto=format&n=O3tlM6eCuFk2uJpN&q=85&s=ad4e229283f3fe2f26c0f96a49f28e13" href="/user-guide/connections/available-connections/gmail" width="88" height="66" data-path="images/connections/gmail.svg">
    Send onboarding, offboarding, or HR status updates using current BambooHR data.
  </Card>

  <Card title="Microsoft Outlook" icon="https://mintcdn.com/duvo-d8027998/O3tlM6eCuFk2uJpN/images/connections/outlook.svg?fit=max&auto=format&n=O3tlM6eCuFk2uJpN&q=85&s=e29aeb65c8cffce1cd3c83b81289b71f" href="/user-guide/connections/available-connections/microsoft-outlook" width="1831" height="1703" data-path="images/connections/outlook.svg">
    Send onboarding, offboarding, or HR status updates using current BambooHR data.
  </Card>

  <Card title="Slack" icon="https://mintcdn.com/duvo-d8027998/O3tlM6eCuFk2uJpN/images/connections/slack.svg?fit=max&auto=format&n=O3tlM6eCuFk2uJpN&q=85&s=8a64bdd1af39e903923e4a273b4a4618" href="/user-guide/connections/available-connections/slack" width="512" height="512" data-path="images/connections/slack.svg">
    Post employee change alerts, time off summaries, or approval follow-ups to the right team channel.
  </Card>

  <Card title="Microsoft Teams" icon="https://mintcdn.com/duvo-d8027998/O3tlM6eCuFk2uJpN/images/connections/teams.svg?fit=max&auto=format&n=O3tlM6eCuFk2uJpN&q=85&s=6402a90678b560d0b0a4fc3b02c0d3e0" href="/user-guide/connections/available-connections/microsoft-teams" width="2229" height="2073" data-path="images/connections/teams.svg">
    Post employee change alerts, time off summaries, or approval follow-ups to the right team channel.
  </Card>
</CardGroup>
