# Rippling REST API

> Use REST APIs to extend Rippling’s platform and automate processes across core resources.

> **Note:**
> Need to quickly find an endpoint? Search and filter the full Rippling REST API using the **[Endpoint search](https://developer.rippling.com/documentation/rest-api/endpoint-search)**.

## Overview

The Rippling REST API lets you read and write company data programmatically - build integrations, leverage automations, and connect Rippling to your existing systems.

Start with the essentials below, use the endpoint search to find a specific endpoint, or open a category guide for deeper walkthroughs on a particular API area.

## Essentials

-   **[Quickstart](https://developer.rippling.com/documentation/rest-api/essentials/quickstart)** - Make your first API call and verify your setup.
-   **[Tokens and permissions](https://developer.rippling.com/documentation/rest-api/essentials/api-tokens)** - Authenticate requests with bearer tokens. Tokens inherit the creator's permissions and selected scopes.
-   **[Scopes](https://developer.rippling.com/documentation/rest-api/essentials/permissions)** - Reference which OAuth scopes grant access to each endpoint.
-   **[Versioning](https://developer.rippling.com/documentation/rest-api/essentials/versioning)** — Breaking changes ship as dated versions (`YYYY-MM-DD`). Pin a version with the `Rippling-Api-Version` header.
-   **[Query parameters](https://developer.rippling.com/documentation/rest-api/essentials/query-parameters)** - Shape responses with `filter`, `expand`, and `order_by`.
-   **[Pagination](https://developer.rippling.com/documentation/rest-api/essentials/pagination)** - Page through list endpoints with `limit` and `cursor`.
-   **[Data models](https://developer.rippling.com/documentation/rest-api/essentials/data-models)** - Understand core resources like User and Worker and how they relate.
-   **[Usage and rate limits](https://developer.rippling.com/documentation/rest-api/essentials/api-limits)** - Global limits, burst thresholds, and how to handle rate-limit errors.
-   **[Errors and troubleshooting](https://developer.rippling.com/documentation/rest-api/essentials/troubleshooting)** - Diagnose common status codes and resolve failed requests.

## Category guides

Beyond the essentials, the **Guides** section is organized by API category. Each category includes a **Getting Started** guide plus additional topic-specific guides—for example, Custom Objects and Reports under Data, Functions under Developer, or Draft Hires under HRIS.

-   **[Data](https://developer.rippling.com/documentation/rest-api/guides/data-getting-started)** - Custom objects, custom fields, and reports across the employee graph.
-   **[Developer](https://developer.rippling.com/documentation/rest-api/guides/dev-getting-started)** - Functions, deployments, and automation built in the Developer app.
-   **[HRIS](https://developer.rippling.com/documentation/rest-api/guides/hris-getting-started)** - Foundational employee data such as users, workers, and compensation.
-   **[IT](https://developer.rippling.com/documentation/rest-api/guides/it-getting-started)** - App user, device, device orders, and software deployment information.
-   **[Organizational Data](https://developer.rippling.com/documentation/rest-api/guides/org-data-getting-started)** — Company structure like departments, titles, entities, and work locations.
-   **[Supergroups](https://developer.rippling.com/documentation/rest-api/guides/supergroups-getting-started)** - Reusable groups for automations, integrations, and policies.
-   **[Talent](https://developer.rippling.com/documentation/rest-api/guides/talent-getting-started)** - Recruiting, headcount planning, performance, and compensation bands.
-   **[Time](https://developer.rippling.com/documentation/rest-api/guides/time-getting-started)** - Schedules, time entries, time off, and timeclock data.

> **Legal notes:**
> Usage is subject to the Rippling developer [Terms of Use](https://app.rippling.com/developer/tos). All API products require authentication and are subject to rate limits.

Source: https://developer.rippling.com/documentation/rest-api/

> For the complete documentation index, see [llms.txt](https://developer.rippling.com/llms.txt). Public pages have a Markdown version at the same URL with .md added.
