# BambooHR

> Connect BambooHR to sanda: what to prepare, the fields the connection form asks for, and how its data lands in your warehouse.

## Connect BambooHR

:::steps
1. **Open the catalogue.** In the console, go to **Data · Connections** and press **New connection**.
2. **Choose BambooHR.** It is listed under people; you can also search for it by name.
3. **Fill in the form.** Enter the fields below. Credentials go straight to sanda’s sync engine and are never stored in sanda’s database.
4. **Choose what to sync.** Pick the tables you want, and a sync mode for each. See [choose what to sync](https://docs.sanda-os.com.au/connections/choose-tables).
5. **Run the first sync.** sanda tests the connection, then lands each table you chose in your warehouse.
:::

## Configuration fields

What the connection form asks for. Required fields are marked; the rest are optional.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| **api_key** | string, secret | Yes | Api key of bamboo hr. |
| **subdomain** | string | Yes | Sub Domain of bamboo hr. |
| **custom_reports_fields** | string | No | Comma-separated list of fields to include in custom reports. |
| **custom_reports_include_default_fields** | boolean | No | If true, the custom reports endpoint will include the default fields defined here: https://documentation.bamboohr.com/docs/list-of-field-names. Default `true`. |
| **employee_fields** | string | No | Comma-separated list of fields to include for employees. Default `firstName,lastName`. |
| **Start date** | string | No |  |

## Related

:::links
- [Sync modes](https://docs.sanda-os.com.au/connections/sync-modes): How sanda reads each table on every run.
- [Sync schedules](https://docs.sanda-os.com.au/connections/schedules): How often a connection runs.
- [Allowlist sanda’s address](https://docs.sanda-os.com.au/connections/allowlist): For a system behind a firewall.
- [Troubleshoot connections](https://docs.sanda-os.com.au/connections/troubleshooting): What an error means and how to fix it.
:::