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

# BambooHR - Getting started in Peliqan

> Learn how to connect BambooHR to Peliqan using an API key and company domain to sync HR data and use data activation features.

BambooHR is a Human Resource Information System (HRIS) that bundles HR features, such as payroll, time tracking, employee engagement, an applicant tracking system  Human Resource Information System (HRIS) that bundles HR features, such as payroll, time tracking, employee engagement, an applicant tracking system (ATS) and more into one system. This cloud-based software is ideal for small to medium-sized businesses (SMBs) that want to optimise their HR processes for efficiency as it houses all employee information in one location for employees, HR professionals, recruiters and managers to easily access.

Small and medium businesses that want to move away from using spreadsheets and/or organize their HR data. BambooHR is an all-in-one HR software solution that sets people free to do great work.

This article details the steps to get started with BambooHR in Peliqan. Please contact support if you have any additional questions or remarks.

## Before Connecting Data Pipeline

BambooHR supports two type integrations, one is personal and other is through App integration. Peliqan supports personal Integration where User creates their own API key and have control over their data.

### Get API Key

1. Login to BambooHR.
2. Once Logged-In, your sub domain is visible

<img src="https://mintcdn.com/peliqan-9d7f0393/bKVGWnFa89T1plmd/images/BambooHR%20-%20Getting%20started%20in%20Peliqan/Untitled%201.png?fit=max&auto=format&n=bKVGWnFa89T1plmd&q=85&s=31669e5c065272a70e5052b9a0a759c3" alt="Untitled 1" title="Untitled 1" width="1276" height="86" data-path="images/BambooHR - Getting started in Peliqan/Untitled 1.png" />

6. On the extreme right, click on the profile tab. A pop-up menu will open, click on "API Keys".

<img src="https://mintcdn.com/peliqan-9d7f0393/bKVGWnFa89T1plmd/images/BambooHR%20-%20Getting%20started%20in%20Peliqan/Untitled%202.png?fit=max&auto=format&n=bKVGWnFa89T1plmd&q=85&s=6385bbf7e176085852c76d5e5ca9779e" alt="BambooHR API Keys menu" className="mx-auto" style={{ width:"49%" }} width="636" height="720" data-path="images/BambooHR - Getting started in Peliqan/Untitled 2.png" />

7. Create API key if not available and save the API key once created.

## BambooHR Data Pipeline

### Connect BambooHR

Connect BambooHR through the Peliqan Connectivity module:

<img src="https://mintcdn.com/peliqan-9d7f0393/bKVGWnFa89T1plmd/images/BambooHR%20-%20Getting%20started%20in%20Peliqan/Untitled%203.png?fit=max&auto=format&n=bKVGWnFa89T1plmd&q=85&s=b88fb4dacefd0c82052a136dc8f9b176" alt="BambooHR Peliqan Connectivity module" width="1358" height="1172" data-path="images/BambooHR - Getting started in Peliqan/Untitled 3.png" />

Configuration Options:

1. API Key (steps are above (steps are above)
2. Company Domain (If you access BambooHR at [https://mycompany.bamboohr.com](https://mycompany.bamboohr.com/), then the companyDomain is 'mycompany' (If you access BambooHR at [https://mycompany.bamboohr.com](https://mycompany.bamboohr.com/), then the companyDomain is 'mycompany')
3. Start Date

Click on Save to proceed with creating pipeline to BambooHR.

Additionally, you can select Endpoints to Sync from *advanced* option for customised pipeline.

<img src="https://mintcdn.com/peliqan-9d7f0393/bKVGWnFa89T1plmd/images/BambooHR%20-%20Getting%20started%20in%20Peliqan/Untitled%204.png?fit=max&auto=format&n=bKVGWnFa89T1plmd&q=85&s=6de80be9809955e46b871e1693745970" alt="BambooHR Advanced options" className="mx-auto" style={{ width:"40%" }} width="440" height="670" data-path="images/BambooHR - Getting started in Peliqan/Untitled 4.png" />

## BambooHR data sync to DataWarehouse

Peliqan offers an out of the box data warehouse. Optionally the user can choose to sync Exact online data to their own data warehouse such as Snowflake, Google Bigquery, MS SQL, etc. By default, it provides Postgres Datawarehouse.

Data will be synced to the chosen data warehouse and made available through the Peliqan UI for exploration.

<img src="https://mintcdn.com/peliqan-9d7f0393/bKVGWnFa89T1plmd/images/BambooHR%20-%20Getting%20started%20in%20Peliqan/Untitled%205.png?fit=max&auto=format&n=bKVGWnFa89T1plmd&q=85&s=8ffb2ad84bf26b3f84484ef28d37632a" alt="BambooHR Data Warehouse sync" width="2926" height="822" data-path="images/BambooHR - Getting started in Peliqan/Untitled 5.png" />

With the Peliqan query engine, queries on the BambooHR data can be written and data can be transformed and combined with other sources.

<img src="https://mintcdn.com/peliqan-9d7f0393/bKVGWnFa89T1plmd/images/BambooHR%20-%20Getting%20started%20in%20Peliqan/Untitled%206.png?fit=max&auto=format&n=bKVGWnFa89T1plmd&q=85&s=26f3543bae2e5d8b60d5dad9e13b2788" alt="BambooHR Query Engine" width="2200" height="1362" data-path="images/BambooHR - Getting started in Peliqan/Untitled 6.png" />

## BambooHR Data Activation

### Get Employee Data

<img src="https://mintcdn.com/peliqan-9d7f0393/bKVGWnFa89T1plmd/images/BambooHR%20-%20Getting%20started%20in%20Peliqan/Untitled%207.png?fit=max&auto=format&n=bKVGWnFa89T1plmd&q=85&s=558e7b919486df8f44e20775f1bf9350" alt="BambooHR Get Employee Data" width="1406" height="582" data-path="images/BambooHR - Getting started in Peliqan/Untitled 7.png" />

### Add an Employee

Peliqan allows adding a new employee data with fields from Employee Model.

<img src="https://mintcdn.com/peliqan-9d7f0393/bKVGWnFa89T1plmd/images/BambooHR%20-%20Getting%20started%20in%20Peliqan/Untitled%208.png?fit=max&auto=format&n=bKVGWnFa89T1plmd&q=85&s=17c6f13f43f945e686b23038a03f6ace" alt="BambooHR Add Employee" width="1364" height="319" data-path="images/BambooHR - Getting started in Peliqan/Untitled 8.png" />

By default, BambooHR doesn't provides ID of the employee created. To get ID(s) of new employee added, sync "employee\_last\_change" with peliqan's SYNC feature.

Employee data can be updated using "Update Employee" function.

### Add TimeOff Request

With peliqan "Add TimeOff Request" function one can make a request for time off.

<img src="https://mintcdn.com/peliqan-9d7f0393/bKVGWnFa89T1plmd/images/BambooHR%20-%20Getting%20started%20in%20Peliqan/Untitled%209.png?fit=max&auto=format&n=bKVGWnFa89T1plmd&q=85&s=4c12027637cb4db6900a6b6655eb0632" alt="BambooHR Add TimeOff Request" width="1531" height="450" data-path="images/BambooHR - Getting started in Peliqan/Untitled 9.png" />

Peliqan also provides "Update TimeOff Request Status" method which allows managers to update the status of request by denying, approving the same.

### Get Job Application Details

"Get application Details" method provides details of a job application based in application\_id

<img src="https://mintcdn.com/peliqan-9d7f0393/bKVGWnFa89T1plmd/images/BambooHR%20-%20Getting%20started%20in%20Peliqan/Untitled%2010.png?fit=max&auto=format&n=bKVGWnFa89T1plmd&q=85&s=098e50136add5613797543058b6c3c9b" alt="BambooHR Get Job Application Details" width="1400" height="489" data-path="images/BambooHR - Getting started in Peliqan/Untitled 10.png" />

### Add Job Hiring Post

Using "Add Job Hiring" lets user to create a new Job Post for Hiring.

<img src="https://mintcdn.com/peliqan-9d7f0393/bKVGWnFa89T1plmd/images/BambooHR%20-%20Getting%20started%20in%20Peliqan/Untitled%2011.png?fit=max&auto=format&n=bKVGWnFa89T1plmd&q=85&s=05a4b1f11fda404cb26457c32d114296" alt="BambooHR Add Job Hiring Post" width="1340" height="416" data-path="images/BambooHR - Getting started in Peliqan/Untitled 11.png" />

Data related to jobs will be visible in "Job\_Summaries" Table under BambooHR Schema in default DataWarehouse.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.