# Rippling

> Manage Rippling HR, payroll, benefits, and PTO - employees, pay statements, departments, and more.

Lets an agent read and manage HR and payroll data in Rippling - employees, payroll groups, pay statements, benefits, organization structure, custom fields, PTO requests, and tax setup.

## What it can do

| Method | What it does |
| --- | --- |
| `rippling_list_employees` | List employees; filter by department, location, or status. |
| `rippling_get_employee` | Get one employee by id. |
| `rippling_search_employees` | Search employees by name, email, or id. |
| `rippling_create_employee` | Create a new employee (write action). |
| `rippling_update_employee` | Update an existing employee (write action). |
| `rippling_list_employee_documents` | List documents attached to an employee. |
| `rippling_list_payroll_groups` | List payroll groups. |
| `rippling_get_payroll_group` | Get one payroll group by id. |
| `rippling_list_pay_periods` | List pay periods for a payroll group; filter by date. |
| `rippling_get_pay_period` | Get a single pay period. |
| `rippling_list_pay_statements` | List pay statements for an employee; filter by date. |
| `rippling_get_pay_statement` | Get a single pay statement. |
| `rippling_create_manual_payment` | Create a manual payment - bonus, correction, or supplemental (write action). |
| `rippling_list_benefit_plans` | List benefit plans; filter by status. |
| `rippling_get_benefit_plan` | Get one benefit plan by id. |
| `rippling_list_benefit_enrollments` | List benefit enrollments for an employee; filter by status. |
| `rippling_get_benefit_enrollment` | Get a single benefit enrollment. |
| `rippling_check_benefit_eligibility` | Check whether an employee is eligible for a benefit plan. |
| `rippling_list_departments` | List departments; optionally active only. |
| `rippling_get_department` | Get one department by id. |
| `rippling_list_locations` | List locations (offices/sites); optionally active only. |
| `rippling_get_location` | Get one location by id. |
| `rippling_list_job_titles` | List job titles. |
| `rippling_get_job_title` | Get one job title by id. |
| `rippling_list_cost_centers` | List cost centers. |
| `rippling_get_cost_center` | Get one cost center by id. |
| `rippling_list_directory` | List the company-wide employee directory. |
| `rippling_list_custom_fields` | List custom fields for an entity type (employee, department, location). |
| `rippling_get_employee_custom_field` | Get a custom field value for an employee. |
| `rippling_set_employee_custom_field` | Set a custom field value for an employee (write action). |
| `rippling_list_absence_requests` | List absence/PTO requests; filter by employee and status. |
| `rippling_get_absence_request` | Get one absence request by id. |
| `rippling_create_absence_request` | Create a new absence/PTO request (write action). |
| `rippling_list_tax_setups` | Get the tax setup/W-4 for an employee. |
| `rippling_update_tax_setup` | Update an employee's W-4 tax setup - state, filing status, exemptions (write action). |

## How to get credentials

1. Sign in at [app.rippling.com](https://app.rippling.com/) as an admin.
2. Go to **Settings** - **API access** (Developer Tools - API Keys).
3. **Generate key** and give it a name (e.g. *FlyMyAI Agent*).
4. Copy the generated API key.

The key is sent as a `Bearer` token on every request, so keep it secret.

## Fields to fill in FlyMyAI

| FlyMyAI field | Where it comes from |
| --- | --- |
| `RIPPLING_API_KEY` | Rippling - Settings - API access - generate key |