# List Users — PagerDuty

> List users in the PagerDuty account, searchable by name or email. Returns user IDs, names, emails, and roles. Optionally filter by team membership using team IDs from List Teams. See the documentation

- Key: `pagerduty-list-users`
- Type: Action (Read-only)
- Version: 0.0.2
- App: PagerDuty (`pagerduty`) — https://pipedream.com/apps/pagerduty.md
- This page (HTML): https://pipedream.com/apps/pagerduty/actions/list-users
- Hints: read-only · open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/pagerduty/actions/list-users/list-users.mjs

## Description

List users in the PagerDuty account, searchable by name or email. Returns user IDs, names, emails, and roles. Optionally filter by team membership using team IDs from **List Teams**. [See the documentation](https://developer.pagerduty.com/api-reference/c96e889522dd6-list-users)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `query` | `string` | No | Filter users by name or email substring. |
| `teamIds` | `string[]` | No | Filter to users belonging to these teams (e.g., ["PTEAM123","PTEAM456"]). Use List Teams to discover IDs. |
| `limit` | `integer` | No | Maximum number of results to return (1–100). Default: 25. |
| `offset` | `integer` | No | Pagination offset. Default: 0. |

## 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": "pagerduty",
      },
    },
  },
)

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: "pagerduty-list-users",
  arguments: {
    query: "Search Query",
    teamIds: ["Team IDs"],
  },
})
```

**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: "pagerduty-list-users",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    pagerduty: { authProvisionId: "apn_xxxxxxx" },
    query: "Search Query",
    teamIds: ["Team IDs"],
  },
})

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": "pagerduty-list-users",
    "configured_props": {
      "pagerduty": { "authProvisionId": "apn_xxxxxxx" },
      "query": "Search Query",
      "teamIds": ["Team IDs"]
    }
  }'
```

---

- App: https://pipedream.com/apps/pagerduty.md · All apps: https://pipedream.com/apps