Read and manage Rippling workers, users, org structure, time off and custom objects through the Rippling REST API.
Rippling ships in the w6w first-party pack. It declares 44 actions, 2 health checks, and the host runs its code in a sandbox that never sees the credential.
io.w6w.ripplingRippling is an HR, IT and payroll platform, and its REST API exposes the same employee system of record the product runs on. This app lets a workflow read workers and users, walk the org structure (departments, teams, work locations, employment types, levels, titles and legal entities), and work with time off — listing requests and balances, creating a request, approving or rejecting one by changing its status.
It also reaches Rippling’s custom fields and custom objects: list an object’s field definitions, query and page through its records, and create, update or delete a record by id or look one up by external id.
Authentication is a Rippling API token, scoped when it is created. What each action returns is bounded by that token’s scopes and by its owner’s permission profile; fields the token may not see come back as null, and every list action reports exactly which ones in redactedFields. Health checks read the Platform API component of Rippling’s status page rather than the company-wide indicator, so a Payroll incident does not mark the API as down.
Three routes to the same 44 actions. The Workflow tab is generated from Rippling's own manifest and carries its real ids, so it is copy-pasteable; the Code and CLI examples are the same call for any action on any app, so every app-specific value in them is a blank you fill in.
company-list The company (or companies) the token can see. Rippling's own quickstart uses this as the first call. Returns one page, forward-paginated. Requires the `companies.read` scope on the API token.
compensation-get Retrieve one compensation by id. Requires the `compensations.read` scope on the API token.
compensation-list Worker compensation records (sensitive: hidden unless the token owner may see it). Returns one page, forward-paginated. Requires the `compensations.read` scope on the API token.
custom-field-list The company's custom field definitions (the fields admins add to worker profiles). Returns one page, forward-paginated. Requires the `custom-fields.read` scope on the API token.
custom-object-field-list The field definitions of one custom object. Requires a `custom-objects.read` scope (or a read-write scope) on the API token.
custom-object-record-create Create a record on a custom object. Requires `custom-object-records.read-write` on the API token. Not idempotent: Rippling documents no idempotency key, so a retry may create a second record unless you set a unique external_id.
custom-object-record-delete Delete a custom object record (answers 204). Requires `custom-object-records.read-write` on the API token. Destructive; deleting an already-deleted record fails with a 404.
custom-object-record-get Retrieve one custom object record by the external_id you stored on it. Requires `custom-object-records.read` (or a read-write scope). Rippling documents no get-by-record-id endpoint, so the external id is the only direct lookup.
custom-object-record-list One page of a custom object's records. Requires `custom-object-records.read` (or a read-write scope) on the API token. This endpoint takes only `limit` and `cursor`; to filter, use Query Custom Object Records.
custom-object-record-query Search a custom object's records with a query string. Requires `custom-object-records.read` (or a read-write scope). Unlike the other lists, this one returns a bare `cursor` rather than a `next_link`.
custom-object-record-update Patch a custom object record. Requires `custom-object-records.read-write` on the API token. Only the fields you send change.
department-create Create a department. Requires the `departments.read-write` scope on the API token. Not idempotent: Rippling documents no idempotency key, so a retry may create a duplicate.
department-get Retrieve one department by id. Requires the `departments.read` scope on the API token.
department-list Departments of the company, optionally nested. Returns one page, forward-paginated. Requires the `departments.read` scope on the API token.
department-update Update a department. Requires the `departments.read-write` scope on the API token. A PATCH: only the fields you set are sent, everything else is left as it is.
employment-type-get Retrieve one employment type by id. Requires the `employment-types.read` scope on the API token.
employment-type-list Employment types (employee or contractor, hourly or salaried, full- or part-time). Returns one page, forward-paginated. Requires the `employment-types.read` scope on the API token.
leave-balance-get Retrieve one leave balance by id. Requires the `leave-balances.read` scope on the API token.
leave-balance-list Per-worker time-off balances by leave type. Returns one page, forward-paginated. Requires the `leave-balances.read` scope on the API token.
leave-request-create Create a time-off request for a worker. A leave type or a leave policy must be given. Requires the `leave-requests.read-write` scope on the API token. Not idempotent: Rippling documents no idempotency key, so a retry may create a duplicate.
leave-request-get Retrieve one leave request by id. Requires the `leave-requests.read` scope on the API token.
leave-request-list Time-off requests. Returns one page, forward-paginated. Requires the `leave-requests.read` scope on the API token.
leave-request-update Update a time-off request: approve or reject it by setting the status, or change its dates and notes. Requires the `leave-requests.read-write` scope on the API token. A PATCH: only the fields you set are sent, everything else is left as it is.
leave-type-get Retrieve one leave type by id. Requires the `leave-types.read` scope on the API token.
leave-type-list Time-off types (vacation, sick, ...). Returns one page, forward-paginated. Requires the `leave-types.read` scope on the API token.
legal-entity-get Retrieve one legal entity by id. Requires the `legal-entities.read` scope on the API token.
legal-entity-list Legal entities the company employs through. Returns one page, forward-paginated. Requires the `legal-entities.read` scope on the API token.
level-list Job levels. Returns one page, forward-paginated. Requires the `levels.read` scope on the API token.
team-create Create a team. Requires the `teams.read-write` scope on the API token. Not idempotent: Rippling documents no idempotency key, so a retry may create a duplicate.
team-list Teams of the company, optionally nested. Returns one page, forward-paginated. Requires the `teams.read` scope on the API token.
team-update Update a team. Requires the `teams.read-write` scope on the API token. A PATCH: only the fields you set are sent, everything else is left as it is.
title-list Job titles. Returns one page, forward-paginated. Requires the `titles.read` scope on the API token.
user-list A user is an account that can sign in and be granted access and roles. Returns one page, forward-paginated. Requires the `users.read` scope on the API token.
work-location-create Create a work location. Requires the `work-locations.read-write` scope on the API token. Not idempotent: Rippling documents no idempotency key, so a retry may create a duplicate.
work-location-delete Delete a work location. Requires the `work-locations.read-write` scope on the API token. Destructive; Rippling answers 204, and a repeat delete fails with a 404.
work-location-get Retrieve one work location by id. Requires the `work-locations.read` scope on the API token.
work-location-list Office and other work locations. Returns one page, forward-paginated. Requires the `work-locations.read` scope on the API token.
work-location-update Update a work location. Requires the `work-locations.read-write` scope on the API token. A PATCH: only the fields you set are sent.
worker-get Retrieve one worker by id. Requires the `workers.read` scope on the API token.
worker-list A worker is a person's HR profile (employment or engagement) in the company. Returns one page, forward-paginated. Requires the `workers.read` scope on the API token.
A workflow step names the app and the action, and the editor fills in the
connection when you pick one. This is the Step shape from the
workflow spec, carrying Rippling's real ids.
{
"manifestVersion": "2",
"name": "rippling-example",
"steps": [
{
"id": "compensation-get",
"uses": {
"app": "io.w6w.rippling",
"action": "compensation-get",
"connection": "conn_YOUR_CONNECTION_ID"
},
"with": {
"id": "<id>"
}
}
]
}compensation-get company-list compensation-list custom-field-list custom-object-field-list +39 more actions available
Every app-specific value here is a blank you have to fill in. An
app action is reached through the connection that authenticates it, so the
address is a connection id, not the app id — and connections belong to your account,
so a public page cannot know yours. Create one for Rippling, then fill in
the three blanks: conn_YOUR_CONNECTION_ID, the action key, and the
parameters that action declares. The call itself is real — the shape is transcribed
from the studio's own snippet builder, which prints the same kind of blanks — but
nothing in it is specific to Rippling. The Workflow tab is where this app's
real ids are.
npm install @w6w/sdkyarn add @w6w/sdkpnpm add @w6w/sdkdeno add npm:@w6w/sdkimport { W6wClient, isActionRun } from "@w6w/sdk";
// Reads W6W_BASE_URL and W6W_TOKEN from the environment when omitted.
const client = new W6wClient();
const envelope = await client.run({
urn: "conn_YOUR_CONNECTION_ID",
action: "compensation-get",
payload: {
id: "<value>",
// expand: "<value>",
},
});
if (isActionRun(envelope)) console.log(envelope.value); npm install -g @w6w/cli w6w run conn_YOUR_CONNECTION_ID --action compensation-get --payload '{"id":"<value>"}' Give an AI agent Rippling — without giving it Rippling's credentials. One MCP endpoint exposes every app, function and workflow the caller is entitled to, as tools it can discover and run. Access is granted per team while we onboard.
One tool call{
"name": "w6w_invoke",
"arguments": {
"ref": "app:io.w6w.rippling#compensation-get",
"input": {
"id": "<id>"
}
}
}
Every tool names its target with a single ref. The
app: form above doesn't name a connection at all — the
host resolves which of the caller's Rippling connections to sign
with, and refuses rather than guesses when the answer is ambiguous.
The token is attached host-side, at the moment of the call. It is never a tool argument, never in the model's context, and never in a transcript — so a prompt injection has nothing to exfiltrate.
Tools are derived per end user from what that person has actually connected and is entitled to — not one shared bot identity carrying the union of everyone's access.
Multi-step work runs on the workflow engine and returns a run handle the agent can poll — retries, branching and state survive the conversation that started them.
Rippling's declared health checks are on the surface too, so an agent can tell "the vendor is down" from "your credential expired" before it burns a retry on either.
The MCP surface is part of the hosted platform. Rippling itself is MIT, and the runtime that executes it is source-available (FSL).
Rippling declares its own checks, so its health is a property of the app rather than something the host guesses at.
status.rippling.com: the Platform API component (weighted fully) plus Rippling App and Authentication (capped at degraded). Payroll, Benefits and the other company-wide components are ignored.
Not exposed: Rippling documents a 300-requests-per-10-seconds burst threshold but no remaining-quota header or usage endpoint.