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

# BambooHR

<div className="page-title-row">
  <img src="https://mintcdn.com/klef/xJ0kXbcegZOD2G3h/images/connectors/bamboo-hr.png?fit=max&auto=format&n=xJ0kXbcegZOD2G3h&q=85&s=d965b2485a50ad112f94a86f49cc2198" alt="" noZoom width="1479" height="227" data-path="images/connectors/bamboo-hr.png" />

  <h1>BambooHR</h1>
</div>

A run reads the whole roster.

## Connection

### Setup

[Create an API key](https://documentation.bamboohr.com/docs/getting-started) from the account menu of
the user Klef should read as.

### Settings

| Setting        | Required | Description                                                                                                      |
| -------------- | -------- | ---------------------------------------------------------------------------------------------------------------- |
| Company domain | Yes      | The name before .bamboohr.com in your BambooHR address.                                                          |
| API key        | Yes      | API key of a BambooHR user who will not be offboarded. Klef reads only what that user can see. Stored encrypted. |

## Fields

The [worker model](/docs/connectors/worker-model) fields Klef fills from BambooHR.

| Field                                     | Type   | Description                                                         |
| ----------------------------------------- | ------ | ------------------------------------------------------------------- |
| `worker.source_id`                        | string | The worker's ID in the HR system.                                   |
| `worker.employee_id`                      | string | Employee number from the HR system. Hidden from the mapping editor. |
| `worker.legal_name`                       | object | Legal name.                                                         |
| `worker.legal_name.given`                 | string | Legal first name.                                                   |
| `worker.legal_name.family`                | string | Legal last name.                                                    |
| `worker.preferred_name`                   | object | Name the worker goes by.                                            |
| `worker.preferred_name.given`             | string | Preferred first name.                                               |
| `worker.preferred_name.family`            | string | Preferred last name.                                                |
| `worker.display_name`                     | string | Full name for display.                                              |
| `worker.business_email`                   | string | Primary business email address.                                     |
| `worker.personal_email`                   | string | Primary personal email address.                                     |
| `worker.status`                           | string | Pending, Active, Leave, Terminated, Deceased or Unspecified.        |
| `worker.start_date`                       | date   | Start date of the primary assignment.                               |
| `worker.end_date`                         | date   | End date of the primary assignment.                                 |
| `worker.hire_date`                        | date   | Original hire date.                                                 |
| `worker.department`                       | object | Department of the primary assignment.                               |
| `worker.department.code`                  | string | Department code.                                                    |
| `worker.department.name`                  | string | Department name.                                                    |
| `worker.job`                              | object | Job of the primary assignment.                                      |
| `worker.job.code`                         | string | Job code.                                                           |
| `worker.job.name`                         | string | Job name.                                                           |
| `worker.manager`                          | string | Source ID of the primary assignment's manager.                      |
| `worker.location`                         | object | Work location of the primary assignment.                            |
| `worker.location.code`                    | string | Location code.                                                      |
| `worker.location.name`                    | string | Location name.                                                      |
| `worker.worker_type`                      | string | Employee or Contractor, from the primary assignment.                |
| `worker.mobile_phone`                     | string | Mobile phone number.                                                |
| `worker.business_phone`                   | string | Business phone number.                                              |
| `worker.assignments`                      | array  | Every job the worker holds.                                         |
| `worker.assignments[].source_id`          | string | The assignment's ID in the HR system.                               |
| `worker.assignments[].is_primary`         | bool   | Whether this is the worker's primary assignment.                    |
| `worker.assignments[].status`             | string | Pending, Active, Leave, Terminated, Deceased or Unspecified.        |
| `worker.assignments[].job`                | object | Job of the assignment.                                              |
| `worker.assignments[].job.code`           | string | Job code.                                                           |
| `worker.assignments[].job.name`           | string | Job name.                                                           |
| `worker.assignments[].business_unit`      | object | Business unit of the assignment.                                    |
| `worker.assignments[].business_unit.code` | string | Business unit code.                                                 |
| `worker.assignments[].business_unit.name` | string | Business unit name.                                                 |
| `worker.assignments[].department`         | object | Department of the assignment.                                       |
| `worker.assignments[].department.code`    | string | Department code.                                                    |
| `worker.assignments[].department.name`    | string | Department name.                                                    |
| `worker.assignments[].location`           | object | Work location.                                                      |
| `worker.assignments[].location.code`      | string | Location code.                                                      |
| `worker.assignments[].location.name`      | string | Location name.                                                      |
| `worker.assignments[].manager`            | string | Source ID of the assignment's manager.                              |
| `worker.assignments[].start_date`         | date   | Start date.                                                         |
| `worker.assignments[].end_date`           | date   | End date.                                                           |
| `worker.assignments[].worker_type`        | string | Employee or Contractor.                                             |