# Get Employees Directory — BambooHR

> Get the company employee directory from BambooHR. Returns the company-configured fieldset for every employee in the published directory; filter client-side, or use fields to keep the response small. The directory may omit inactive/former…

- Key: `bamboohr-get-employees-directory`
- 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/get-employees-directory
- Hints: read-only · open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/bamboohr/actions/get-employees-directory/get-employees-directory.mjs

## Description

Get the company employee directory from BambooHR. Returns the company-configured fieldset for every employee in the published directory; filter client-side, or use `fields` to keep the response small. The directory may omit inactive/former employees and anyone the company excludes from sharing, so it is not an authoritative employee roster. Use this to discover employee IDs before calling **Get Employee**, **Update Employee**, or time-tracking actions. [See the documentation](https://documentation.bamboohr.com/reference/get-employees-directory)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `onlyCurrent` | `boolean` | No | When true (default), returns only currently-active employees. |
| `fields` | `string` | No | Comma-separated field names to keep on each employee (e.g. id,displayName,jobTitle,workEmail), applied client-side after the API call. id is always included. The directory returns every company-configured field for every employee (often including large signed photo URLs), so a large company's full response can exceed the model's context — pass this to keep only what you need. Omit to get the full response unchanged. |

## 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-get-employees-directory",
  arguments: {
    onlyCurrent: true,
    fields: "Fields",
  },
})
```

**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-get-employees-directory",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    bamboohr: { authProvisionId: "apn_xxxxxxx" },
    onlyCurrent: true,
    fields: "Fields",
  },
})

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-get-employees-directory",
    "configured_props": {
      "bamboohr": { "authProvisionId": "apn_xxxxxxx" },
      "onlyCurrent": true,
      "fields": "Fields"
    }
  }'
```

---

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