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)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-list-time-off-requests",
"configured_props": {
"bamboohr": { "authProvisionId": "apn_xxxxxxx" },
"start": "Start",
"end": "End"
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{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-list-time-off-requests",
arguments: {
start: "Start",
end: "End",
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| 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
- Source
- View on GitHub ↗