View as Markdown
BambooHR icon

BambooHR ACTION

List Employees

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

IMPLEMENTATION

Call this tool

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

SCHEMA

Inputs

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

List Employees inputs
Property Type Description
filter Filter object
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"}.
Optional
sort Sort string
Comma-separated sort over employeeId, firstName, lastName, preferredName, jobTitleName, status; prefix a field with - for descending, e.g. -lastName,firstName.
Optional
fields Fields string
Comma-separated additional fields to include beyond the defaults, e.g. workEmail,mobilePhone,departmentName.
Optional
pageLimit Page Limit integer
Maximum records to return. Min 1, max 2500 (default 250).
Optional
pageAfter Page After string
Cursor to fetch the next page, from the previous response's meta.page.nextCursor.
Optional
pageBefore Page Before string
Cursor to fetch the previous page, from the previous response's meta.page.prevCursor.
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-list-employees
Version
0.0.1
App
BambooHR
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes