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

# Rippling

> Access Rippling HR data - employees, departments, teams, and leave requests - via the Rippling platform API

## At a glance

* **Availability**: Experimental ([how to enable](/cloud/integrations)).
* **Auth**: API key.
* **Connection**: The key from `RIPPLING_API_TOKEN` is sent as the `Bearer` prefixed `Authorization` header.
* **Docs**: [https://developer.rippling.com/documentation/base-api](https://developer.rippling.com/documentation/base-api)

## Credentials

Set these per environment. See [Connect an integration](/cloud/integrations).

| Variable             | Required | Description                                                                                                                                                                                                 |
| -------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `RIPPLING_API_TOKEN` | Yes      | Rippling API token (Bearer). Issued for custom API integrations by your Rippling admin, or as an app access token for approved Rippling apps [Docs](https://developer.rippling.com/documentation/base-api). |

## Setup

1. **Confirm API access**: Rippling API access is not open by default. Customers can obtain an API token for custom integrations through their Rippling account (API access may require a plan add-on); software vendors register an app at [https://developer.rippling.com](https://developer.rippling.com) and receive tokens once approved.
2. **Get your API token**: As a Rippling admin, create or retrieve your company API token from the Rippling admin console (Settings → Company API / custom integration settings), or use the access token issued for your approved app integration.
3. **Store the token**: Add RIPPLING\_API\_TOKEN=\<your token> to your .env file. Requests are sent to [https://api.rippling.com/platform/api](https://api.rippling.com/platform/api) with an Authorization: Bearer header.
4. **Verify access**: Run the List Employees tool. The token's scopes (granted at creation/approval) determine which resources are readable; a 403 means the token lacks the scope for that endpoint.

* This connector targets the token-authenticated platform API (api.rippling.com/platform/api); Rippling's newer REST API for App Shop partners uses OAuth app installs and is not covered here
* List endpoints paginate with limit/offset (recommended max limit 100)
* Returned data is limited by the scopes granted to your token or app

Provider API reference: [https://developer.rippling.com/documentation/base-api](https://developer.rippling.com/documentation/base-api)

## Tools

| Tool                  | Access | Description                                                                              |
| --------------------- | ------ | ---------------------------------------------------------------------------------------- |
| List Employees        | Read   | List active employees in the Rippling company with pagination                            |
| Get Employee          | Read   | Get a single employee's record (title, department, work location, employment type) by ID |
| List Departments      | Read   | List the company's departments                                                           |
| List Teams            | Read   | List the company's teams                                                                 |
| List Leave Requests   | Read   | List leave (time off) requests with optional status and date filtering                   |
| Process Leave Request | Write  | Approve or decline a pending leave request                                               |

## Example prompts

* List employees from Rippling and summarize headcount by department and team.
* Check Rippling for approved leave requests overlapping this week and tell me who is out of office.
* Look up an employee I specify in Rippling and summarize their role, department, and work location.