View as Markdown
Breezy HR icon

Breezy HR ACTION

Get Candidate

Retrieve a candidate by ID for a given position. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Breezy HR account once, then configure and run Get Candidate 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: "breezy_hr-get-candidate",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    breezy_hr: { authProvisionId: "apn_xxxxxxx" },
    companyId: "Company",
    positionId: "Position",
  },
})

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 Candidate inputs
Property Type Description
companyId Company string
The Breezy HR company
Required Dynamic
positionId Position string
The position that contains the candidate. (This will only show published positions)
Required Dynamic
candidateId Candidate string
The candidate to retrieve
Required Dynamic

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
breezy_hr-get-candidate
Version
0.0.1
App
Breezy HR
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes