View as Markdown
Rippling icon

Rippling ACTION

List Workers

Retrieves a list of all workers from Rippling. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Rippling account once, then configure and run List Workers from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "rippling-list-workers",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    rippling: { authProvisionId: "apn_xxxxxxx" },
    filter: "Filter",
    expand: ["Expand"],
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

List Workers inputs
Property Type Description
filter Filter string
Filter workers by field. Filterable fields: status, work_email, user_id, created_at, updated_at. Example: status+eq+'ACTIVE' See the documentation for more information.
Optional
expand Expand string[]
Expand fields
Optional
orderBy Order By string
The field to order the results by
Optional
orderDirection Order Direction string
The direction to order the results by
Optional
maxResults Max Results integer
The maximum number of results to return
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
rippling-list-workers
Version
0.0.2
App
Rippling
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes