View as Markdown
BambooHR icon

BambooHR ACTION

Get Employees Directory

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
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's BambooHR account once, then configure and run Get Employees Directory 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: "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)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Get Employees Directory inputs
Property Type Description
onlyCurrent Only Current boolean
When true (default), returns only currently-active employees.
Optional
fields Fields string
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.
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
bamboohr-get-employees-directory
Version
0.0.1
App
BambooHR
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes