Peakon Employee Voice ACTION
List Employees
Lists employee records in Peakon. Use the filter parameters to narrow results by email, account ID, admin status, employee ID, manager status, or segment membership. Returns each employee's internal
id, name, identifier (HR employee number), employment status, and custom HR attributes (Department, Region, Job Level, etc.). The id field returned here is required by Update Employee and Delete Employee. Call this first whenever the user refers to an employee by name or attribute and you need their ID to perform an update or deletion. See the Peakon API documentation- Action
- Read only
- OAuth
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Peakon Employee Voice account once, then configure and run List Employees 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: "peakon_employee_voice-list-employees",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
peakon_employee_voice: { authProvisionId: "apn_xxxxxxx" },
filterEmail: "Filter by Email",
filterAccountId: 10,
},
})
console.log(result)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "peakon_employee_voice-list-employees",
"configured_props": {
"peakon_employee_voice": { "authProvisionId": "apn_xxxxxxx" },
"filterEmail": "Filter by Email",
"filterAccountId": 10
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "peakon_employee_voice",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "peakon_employee_voice-list-employees",
arguments: {
filterEmail: "Filter by Email",
filterAccountId: 10,
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
filterEmail Filter by Email | string | Filter employees by account email address. Optional |
filterAccountId Filter by Account ID | integer | Filter employees by their account ID. Optional |
filterAdmin Filter Admins Only | boolean | When true, returns only employees with admin access. Optional |
filterEmployeeId Filter by Employee ID | integer | Filter by the employee's internal numeric ID. Optional Dynamic |
filterManager Filter Managers Only | boolean | When true, returns only employees who are managers. Optional |
filterSegmentIds Filter by Segment IDs | string | Comma-separated list of segment IDs to filter by segment membership. Example: 1001,1002. Use List Segments to discover available segment IDs. 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
- peakon_employee_voice-list-employees
- Version
- 0.0.2
- App
- Peakon Employee Voice
- Authentication
- OAuth
- Read-only
- Yes
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗