View as Markdown
BambooHR icon

BambooHR ACTION

Get Company Report

Get a saved company report by ID. Report IDs are company-specific. In JSON, returns {title, fields, employees}. 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 Company Report 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-company-report",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    bamboohr: { authProvisionId: "apn_xxxxxxx" },
    reportId: "Report ID",
    format: "Format",
  },
})

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 Company Report inputs
Property Type Description
reportId Report ID string
The saved report ID (company-specific), e.g. 1. Find it by hovering over the report name in BambooHR's Custom Reports (or My Reports) list and noting the ID in the URL.
Required
format Format string
Output format. One of json, xml, csv, xls, pdf (default json).
Optional
fd Filter Duplicates string
Duplicate-row filtering. Use yes to filter duplicates or no to return raw rows.
Optional
onlyCurrent Only Current boolean
When true (default), limits to current employees.
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-company-report
Version
0.0.1
App
BambooHR
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes