View as Markdown
BambooHR icon

BambooHR ACTION

List Who's Out

List a date-sorted feed of employees who are out and company holidays for a period. Returns 403 if the Who's Out feature is disabled for the account. 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 Who's Out 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-whos-out",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    bamboohr: { authProvisionId: "apn_xxxxxxx" },
    start: "Start",
    end: "End",
  },
})

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 Who's Out inputs
Property Type Description
start Start string
Start date in YYYY-MM-DD format (defaults to today).
Optional
end End string
End date in YYYY-MM-DD format (defaults to 14 days after start).
Optional
filter Filter string
Set to off to bypass saved filters for employee time off. Does not affect holiday filtering.
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-whos-out
Version
0.0.1
App
BambooHR
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes