View as Markdown
BambooHR icon

BambooHR ACTION

List Time Off Requests

List time off requests within a date range. To fetch your own requests, set the Action parameter to myRequests (passing employeeId=0 returns an empty array). Use List Time Off Types to find type IDs. 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 Time Off Requests 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-time-off-requests",
  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 Time Off Requests inputs
Property Type Description
start Start string
Start of range in YYYY-MM-DD format, e.g. 2026-01-01.
Required
end End string
End of range in YYYY-MM-DD format, e.g. 2026-01-31.
Required
employeeId Employee ID string
Filter to a specific employee ID, e.g. 12345. Do NOT use 0 (returns empty); set the Action parameter to myRequests to fetch your own requests. Run Get Employees Directory to discover IDs.
Optional
id Request ID string
Filter to a specific time off request ID, e.g. 67890. Run List Time Off Requests (without this filter) to discover IDs.
Optional
action Action string
One of view, approve, myRequests (default view).
Optional
type Type string
Comma-separated time off type IDs, e.g. 1,2. Run List Time Off Types to discover IDs.
Optional
status Status string
Comma-separated statuses: approved, denied, superceded, requested, canceled.
Optional
excludeNote Exclude Note boolean
When true, omit note text from results.
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-time-off-requests
Version
0.0.1
App
BambooHR
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes