Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Rippling

Rippling Platform API

The Platform API from Rippling — 24 operation(s) for platform.

Provider Profile APIs.io OpenAPI GitHub

Rippling Platform API is one of 22 APIs that Rippling publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Platform. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 29 operations across 24 paths. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://api.rippling.com.

29 operations 24 paths 0 schemas 1 DELETE19 GET2 PATCH6 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Server
https://api.rippling.com
Authentication
HTTP Bearer
Contact
Rippling Developer Portal
License
Proprietary
Resource Areas
1

Authentication & Security 1

Rippling Platform API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — Rippling API tokens are issued via OAuth2 (or generated as personal/app tokens) and supplied as Authorization: Bearer .

Paths & Operations 29

Across 24 paths, the API surfaces 29 operations — 1 DELETE, 19 GET, 2 PATCH, 6 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Platform 29
GET
/platform/api/me
Get the authenticated user / current token context
getMe → 200401
GET
/platform/api/companies
List companies accessible to the token
getCompanies → 200401
GET
/platform/api/company_activity
List recent company activity events
getCompanyActivity 3 params → 200401
GET
/platform/api/employees
List active employees
getEmployees 2 params → 200401
GET
/platform/api/employees/include_terminated
List employees including terminated workers
getEmployeesIncludeTerminated 2 params → 200401
GET
/platform/api/employees/{employee_id}
Get an employee by ID
getEmployeeById 1 param → 200401404
GET
/platform/api/departments
List departments
getDepartments → 200401
GET
/platform/api/work_locations
List work locations
getWorkLocations → 200401
GET
/platform/api/levels
List career/job levels
getLevels → 200401
GET
/platform/api/teams
List teams
getTeams → 200401
GET
/platform/api/custom_fields
List custom field definitions
getCustomFields → 200401
GET
/platform/api/groups
List groups
getGroups → 200401
POST
/platform/api/groups
Create a group
createGroup body → 201401
GET
/platform/api/groups/{group_id}
Get a group by ID
getGroupById 1 param → 200401
PATCH
/platform/api/groups/{group_id}
Partially update a group
patchGroup 1 param body → 200401
PUT
/platform/api/groups/{group_id}
Replace a group
putGroup 1 param body → 200401
DELETE
/platform/api/groups/{group_id}
Delete a group
deleteGroup 1 param → 204401
GET
/platform/api/leave_requests
List leave requests
getLeaveRequests 2 params → 200401
POST
/platform/api/leave_requests
Create a leave request
createLeaveRequest body → 201401
PATCH
/platform/api/leave_requests/{leave_request_id}
Update a leave request
patchLeaveRequest 1 param body → 200401
POST
/platform/api/leave_requests/process
Approve or reject a leave request
processLeaveRequest body → 200401
POST
/platform/api/leave_requests/cancel
Cancel a leave request
cancelLeaveRequest body → 200401
GET
/platform/api/leave_balances
List leave balances for all employees
getLeaveBalances → 200401
GET
/platform/api/leave_balances/{employee_id}
Get leave balance for one employee
getLeaveBalance 1 param → 200401
GET
/platform/api/company_leave_types
List company-defined leave types
getCompanyLeaveTypes → 200401
GET
/platform/api/saml/idp_metadata
Retrieve SAML Identity Provider metadata for the company
getSamlIdpMetadata → 200401
GET
/platform/api/app/matching_users
List users in the company that match the calling app
getAppMatchingUsers → 200401
POST
/platform/api/mark_app_installed
Mark the calling app as installed for the company
markAppInstalled → 200401
POST
/platform/api/ats/candidates/push_candidate
Push an ATS candidate into Rippling
pushAtsCandidate body → 201401

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rippling-platform-api-openapi.yml Raw ↑

Other APIs Rippling publishes across the network.

Rippling Employees API
AE Profile APIs.io
Rippling Companies API
AE Profile APIs.io
Rippling Departments API
AE Profile APIs.io
Rippling Teams API
AE Profile APIs.io
Rippling Work Locations API
AE Profile APIs.io
Rippling Payroll API
AE Profile APIs.io
Rippling Time Off API
AE Profile APIs.io
Rippling Time Tracking API
AE Profile APIs.io
Rippling Benefits API
AE Profile APIs.io
Rippling Expenses API
AE Profile APIs.io
Rippling Corporate Cards API
AE Profile APIs.io
Rippling Bill Pay API
AE Profile APIs.io
#Platform
← Back to R APIs
API Details
ID
rippling:rippling-platform-api
Server
https://api.rippling.com
Provider
Rippling
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network