View as Markdown
BambooHR icon

BambooHR ACTION

Get Time Off Balance

Get time off balances for an employee as of a date. Returns one entry per assigned policy. Run Get Employees Directory to find the employee ID. 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 Time Off Balance 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-time-off-balance",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    bamboohr: { authProvisionId: "apn_xxxxxxx" },
    employeeId: "Employee ID",
    end: "End Date",
  },
})

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 Time Off Balance inputs
Property Type Description
employeeId Employee ID string
The employee ID (digits only; 0 is not accepted), e.g. 12345. Run Get Employees Directory to discover IDs.
Required
end End Date string
As-of date in YYYY-MM-DD format (defaults to today), e.g. 2026-12-31.
Optional
precision Precision integer
Decimal precision for balances. Min 0, max 4 (default 2).
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-time-off-balance
Version
0.0.1
App
BambooHR
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes