For AI agents: an index of this documentation is at https://developer.rippling.com/llms.txt. Public pages have a Markdown version at the same URL with .md added.

Skip to main content
api

Rippling REST API

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

Use with AI:Rippling AI ChatGPT Claude Cursor

Need to quickly find an endpoint? Search and filter the full Rippling REST API using the 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 - Make your first API call and verify your setup.
  • Tokens and permissions - Authenticate requests with bearer tokens. Tokens inherit the creator's permissions and selected scopes.
  • Scopes - Reference which OAuth scopes grant access to each endpoint.
  • Versioning — Breaking changes ship as dated versions (YYYY-MM-DD). Pin a version with the Rippling-Api-Version header.
  • Query parameters - Shape responses with filter, expand, and order_by.
  • Pagination - Page through list endpoints with limit and cursor.
  • Data models - Understand core resources like User and Worker and how they relate.
  • Usage and rate limits - Global limits, burst thresholds, and how to handle rate-limit errors.
  • Errors and 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 - Custom objects, custom fields, and reports across the employee graph.
  • Developer - Functions, deployments, and automation built in the Developer app.
  • HRIS - Foundational employee data such as users, workers, and compensation.
  • IT - App user, device, device orders, and software deployment information.
  • Organizational Data — Company structure like departments, titles, entities, and work locations.
  • Supergroups - Reusable groups for automations, integrations, and policies.
  • Talent - Recruiting, headcount planning, performance, and compensation bands.
  • Time - Schedules, time entries, time off, and timeclock data.
Legal notes

Usage is subject to the Rippling developer Terms of Use. All API products require authentication and are subject to rate limits.