# List Employees — BambooHR

> List employees with optional filtering, sorting, and cursor-based pagination. Every record includes employeeId, firstName, lastName, preferredName, photoUrl, jobTitleName, status, and _restrictedFields by default; use fields for more…

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

## Description

List employees with optional filtering, sorting, and cursor-based pagination. Every record includes `employeeId`, `firstName`, `lastName`, `preferredName`, `photoUrl`, `jobTitleName`, `status`, and `_restrictedFields` by default; use `fields` for more. Restricted fields you can't read return `null` and are listed in `_restrictedFields`. [See the documentation](https://documentation.bamboohr.com/reference/list-employees)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `filter` | `object` | No | Filter employees by field as name-value pairs, e.g. {"status":"Active","lastName":"Doe"}. Names/addresses match by substring; IDs, enums, and dates match by equality. Use the special ids key with a comma-separated list to filter to specific employee IDs, e.g. {"ids":"100,101,102"}. |
| `sort` | `string` | No | Comma-separated sort over employeeId, firstName, lastName, preferredName, jobTitleName, status; prefix a field with - for descending, e.g. -lastName,firstName. |
| `fields` | `string` | No | Comma-separated additional fields to include beyond the defaults, e.g. workEmail,mobilePhone,departmentName. |
| `pageLimit` | `integer` | No | Maximum records to return. Min 1, max 2500 (default 250). |
| `pageAfter` | `string` | No | Cursor to fetch the next page, from the previous response's meta.page.nextCursor. |
| `pageBefore` | `string` | No | Cursor to fetch the previous page, from the previous response's meta.page.prevCursor. |

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

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: "bamboohr-list-employees",
  arguments: {
    filter: "Filter",
    sort: "Sort",
  },
})
```

**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: "bamboohr-list-employees",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    bamboohr: { authProvisionId: "apn_xxxxxxx" },
    filter: "Filter",
    sort: "Sort",
  },
})

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": "bamboohr-list-employees",
    "configured_props": {
      "bamboohr": { "authProvisionId": "apn_xxxxxxx" },
      "filter": "Filter",
      "sort": "Sort"
    }
  }'
```

---

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