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

# Rippling

> Rippling REST API access for reading workers, companies, departments, and work locations for a connected Rippling account.

Rippling REST API access for reading workers, companies, departments, and work locations for a connected Rippling account. Use when an agent needs employee or org data from Rippling. Connects with a Rippling API key (entered once on the Pipedream-hosted screen, not OAuth); Pipedream stores and injects it, so Lava holds no key.

5 example endpoints available through Lava's AI Gateway. See the [Rippling API docs](https://developer.rippling.com/documentation/rest-api) for full documentation.

<Warning>This provider requires your own credentials — connect your API key or OAuth account before use.</Warning>

<Info>This is a **catch-all provider** — any valid URL under `https://rest.ripplingapis.com` is supported. Rippling REST API. Base [https://rest.ripplingapis.com](https://rest.ripplingapis.com). Resources are root-level plural collections with no version prefix: /workers (list), /workers/\{id} (one), /companies, /departments, /work-locations, /users. Pagination is cursor-based: limit and cursor, and the response carries a next\_link URL to follow. Pin the version with an optional Rippling-Api-Version: YYYY-MM-DD header. The connected key's permissions scope what is returned; fields you lack access to come back under \_\_meta.redacted\_fields rather than erroring. Auth (the API key) is brokered by Pipedream, do not send an Authorization header. This provider is read-only: only GET requests are supported. The endpoints below are curated examples.</Info>

## Endpoints

### List workers (the primary employee list). Paginate with limit and cursor, follow next\_link.

**GET** `https://rest.ripplingapis.com/workers?limit=50` — Free

<Tabs>
  <Tab title="SDK">
    ```typescript theme={null}
    const data = await lava.gateway('https://rest.ripplingapis.com/workers?limit=50', { method: 'GET' });
    ```
  </Tab>

  <Tab title="cURL">
    ```bash theme={null}
    curl "https://api.lava.so/v1/forward?u=https%3A%2F%2Frest.ripplingapis.com%2Fworkers%3Flimit%3D50" \
      -H "Authorization: Bearer $LAVA_SECRET_KEY"
    ```
  </Tab>
</Tabs>

### Retrieve a single worker by id.

**GET** `https://rest.ripplingapis.com/workers/{id}` — Free

<Tabs>
  <Tab title="SDK">
    ```typescript theme={null}
    const data = await lava.gateway('https://rest.ripplingapis.com/workers/{id}', { method: 'GET' });
    ```
  </Tab>

  <Tab title="cURL">
    ```bash theme={null}
    curl "https://api.lava.so/v1/forward?u=https%3A%2F%2Frest.ripplingapis.com%2Fworkers%2F%7Bid%7D" \
      -H "Authorization: Bearer $LAVA_SECRET_KEY"
    ```
  </Tab>
</Tabs>

### List companies / legal entities for the connected account. Useful to confirm which org the key belongs to.

**GET** `https://rest.ripplingapis.com/companies` — Free

<Tabs>
  <Tab title="SDK">
    ```typescript theme={null}
    const data = await lava.gateway('https://rest.ripplingapis.com/companies', { method: 'GET' });
    ```
  </Tab>

  <Tab title="cURL">
    ```bash theme={null}
    curl "https://api.lava.so/v1/forward?u=https%3A%2F%2Frest.ripplingapis.com%2Fcompanies" \
      -H "Authorization: Bearer $LAVA_SECRET_KEY"
    ```
  </Tab>
</Tabs>

### List departments. Use /departments/\{id} for one.

**GET** `https://rest.ripplingapis.com/departments` — Free

<Tabs>
  <Tab title="SDK">
    ```typescript theme={null}
    const data = await lava.gateway('https://rest.ripplingapis.com/departments', { method: 'GET' });
    ```
  </Tab>

  <Tab title="cURL">
    ```bash theme={null}
    curl "https://api.lava.so/v1/forward?u=https%3A%2F%2Frest.ripplingapis.com%2Fdepartments" \
      -H "Authorization: Bearer $LAVA_SECRET_KEY"
    ```
  </Tab>
</Tabs>

### List work locations.

**GET** `https://rest.ripplingapis.com/work-locations` — Free

<Tabs>
  <Tab title="SDK">
    ```typescript theme={null}
    const data = await lava.gateway('https://rest.ripplingapis.com/work-locations', { method: 'GET' });
    ```
  </Tab>

  <Tab title="cURL">
    ```bash theme={null}
    curl "https://api.lava.so/v1/forward?u=https%3A%2F%2Frest.ripplingapis.com%2Fwork-locations" \
      -H "Authorization: Bearer $LAVA_SECRET_KEY"
    ```
  </Tab>
</Tabs>

## Next Steps

<CardGroup cols={2}>
  <Card title="All Providers" icon="grid" href="/gateway/supported-providers">
    Browse all supported AI providers
  </Card>

  <Card title="Forward Proxy" icon="route" href="/gateway/forward-proxy">
    Learn how to construct proxy URLs and authenticate requests
  </Card>
</CardGroup>