# List Segments — Peakon Employee Voice

> 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…

- Key: `peakon_employee_voice-list-segments`
- Type: Action (Read-only)
- Version: 0.0.2
- App: Peakon Employee Voice (`peakon_employee_voice`) — https://pipedream.com/apps/peakon-employee-voice.md
- This page (HTML): https://pipedream.com/apps/peakon-employee-voice/actions/list-segments
- Hints: read-only · open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/peakon_employee_voice/actions/list-segments/list-segments.mjs

## Description

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](https://developer.peakon.com/reference/get_segments)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `filterAttributeId` | `integer` | No | The ID of the attribute that is the source of a segment. |
| `filterDirect` | `boolean` | No | When true, returns segments including only direct reports. When false, includes all reports. |
| `filterManagerId` | `integer` | No | The employee ID of a manager to filter segments by. Use List Employees to find the ID. |
| `filterType` | `string` | No | The type of attribute that is the source of a segment. |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
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 accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_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-segments",
  arguments: {
    filterAttributeId: 10,
    filterDirect: true,
  },
})
```

**TypeScript**

```ts
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)
```

**cURL**

```bash
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-segments",
    "configured_props": {
      "peakon_employee_voice": { "authProvisionId": "apn_xxxxxxx" },
      "filterAttributeId": 10,
      "filterDirect": true
    }
  }'
```

---

- App: https://pipedream.com/apps/peakon-employee-voice.md · All apps: https://pipedream.com/apps