View as Markdown
Peakon Employee Voice icon

Peakon Employee Voice ACTION

List Segments

Lists all demographic and organizational segments configured in Peakon. Each segment includes a contextId that can be passed to Get Engagement Overview and Get Driver Scores to scope analytics to a specific population (e.g. a department, region, or tenure band). Call this first whenever the user asks about a specific team, department, or demographic group and needs analytics scoped to it. 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 Segments 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-segments",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    peakon_employee_voice: { authProvisionId: "apn_xxxxxxx" },
    filterAttributeId: 10,
    filterDirect: true,
  },
})

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 Segments inputs
Property Type Description
filterAttributeId Filter by Attribute ID integer
The ID of the attribute that is the source of a segment.
Optional
filterDirect Filter Direct Reports Only boolean
When true, returns segments including only direct reports. When false, includes all reports.
Optional
filterManagerId Filter by Manager ID integer
The employee ID of a manager to filter segments by. Use List Employees to find the ID.
Optional
filterType Filter by Type string
The type of attribute that is the source of a segment.
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-segments
Version
0.0.2
App
Peakon Employee Voice
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes