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

# BambooHR API

> Find the employees HR added or changed in your clients' BambooHR, read each one's job, department, manager and work contacts, and write back their work email; personal details, pay, time, talent, files and reports when you turn them on

The common use is onboarding and account changes from the HR system: a scheduled agent asks a client's BambooHR who was added or changed since its last run, reads each employee's record, creates or updates their Microsoft 365 account with the values BambooHR holds, and writes the new work email back to BambooHR.

> [!NOTE]
>
> Automatically enabled when you configure BambooHR permissions in your agent workflow. BambooHR is connected per client, so the agent calls the BambooHR company of the company it works on.

## What it does

* Find the employees added, changed or removed since a time, and the table rows that changed
* Read an employee's record with the fields the job needs, and their job, employment status and asset history
* List and filter employees, and read the company directory and BambooHR users
* Add employees, change their fields, and add or change rows in their tables
* Read and change time off, time tracking and schedules, hiring, onboarding, training and goals
* Read and change compensation, benefits, personal details, file names, reports and datasets, custom fields and company settings
* Read and change webhooks

Neo does not upload or download a file's content: the agent lists an employee's or the company's files, and a person opens or adds the file in BambooHR. Neo asks BambooHR for JSON only, so a report runs as JSON, never as a CSV, Excel or PDF file. Neo does not delete an employee: to end someone's employment, the agent adds a Terminated row to their employment status.

Neo replaces government identity numbers (such as social security, social insurance and national insurance numbers, national ids, employer identification numbers and passport numbers) and webhook signing keys in every BambooHR answer, so the agent never reads one. A report column of an identity-number type is replaced too. A write that sends Neo's placeholder back is refused, so BambooHR keeps the value it has, and a webhook may not send one of those fields to its address.

## Fields and tables

An agent names the fields it reads or writes, and each field needs its permission group: a home address or birth date needs Personal Details, a pay rate needs Compensation & Benefits, and a field the client added in BambooHR needs Custom Fields & Tables. The same holds for the fields a list filters or sorts on, the fields a webhook watches and sends, and the tables an agent reads or writes, such as the compensation or emergency contacts table. A write asks a technician when a group it writes asks.

## Permission groups

| Group | Access levels | Covers |
| - | - | - |
| Employees | Disabled, Read Only, Read / Write | Who was added, changed or removed; the employee record (names, job title, department, division, location, manager, work email and phones, hire and termination dates, employment status); the job and employment status history; assets; BambooHR users; field and list names; adding and updating employees |
| Personal Details | Disabled, Read Only, Read / Write | The company directory (with Custom Fields & Tables, because the company picks its fields); home address, personal email and phone, birth date, gender, marital status, ethnicity, nationality, emergency contacts, dependants, passports, visas, driving licences, education, health and vaccination records, and employment verifications |
| Compensation & Benefits | Disabled, Read Only, Read / Write | Pay rate and type, compensation history, bonuses, commissions, earnings, equity and stock options, payroll fields, benefits, compensation planning and benchmarks, pay grades and bands, and total rewards |
| Time Off | Disabled, Read Only, Read / Write | Time off requests, balances, policies and categories, who's out, holidays and the company calendar |
| Time Tracking & Scheduling | Disabled, Read Only, Read / Write | Timesheets, clock and hour entries, projects and tasks, breaks, kiosks and time clocks, shifts and schedules |
| Talent & Onboarding | Disabled, Read Only, Read / Write | Job openings and applicants, new hire packets and onboarding, training, certifications and performance goals |
| Files | Disabled, Read Only, Read / Write | The names, categories and sharing of company files and each employee's files |
| Reports & Datasets | Disabled, Read Only, Read / Write | Saved and custom reports and datasets. A report or dataset can hold any field the BambooHR user sees |
| Custom Fields & Tables | Disabled, Read Only, Read / Write | The fields and tables the client added to its employee records. Neo cannot tell what they hold |
| Company Settings | Disabled, Read Only, Read / Write | Company information, locations, the options of list fields, custom field and table definitions, and alerts |
| Webhooks | Disabled, Read Only, Read / Write | Webhooks, which send employee changes to an address outside BambooHR, and their logs |

## Access profiles

| Profile | What runs on its own | What asks a technician |
| - | - | - |
| **Read Only** | Reads in Employees, Time Off, Time Tracking & Scheduling, Talent & Onboarding, Custom Fields & Tables, Company Settings and Webhooks | No write is allowed |
| **Helpdesk** | The same reads | A change to an employee's record or custom fields |
| **IT Admin** | Every read and write in those seven groups but Webhooks | A webhook write |
| **Full Automation** | Every other BambooHR call Neo sends, in every group | Creating or changing a webhook; naming a compensation planning cycle's admins or approvers |

Read Only, Helpdesk and IT Admin keep Personal Details, Compensation & Benefits, Files and Reports & Datasets off. Turn one on by hand for an agent that needs it.

## Safety Controls

Creating or changing a webhook always asks a technician, whatever the access profile: a webhook sends employee data to the address it names, outside BambooHR, on every later change. Naming a compensation planning cycle's admins, its final approver, or an approval flow's recommenders and approvers always asks too, because it gives someone authority over pay. Every other BambooHR write follows its group's approval setting and the agent's access profile.


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