View as Markdown
Ashby icon

Ashby ACTION

Search Candidates

Search candidates by email and/or name. Limited to 100 results. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Ashby account once, then configure and run Search Candidates 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: "ashby-search-candidates",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    ashby: { authProvisionId: "apn_xxxxxxx" },
    email: "Email",
    name: "Name",
  },
})

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.

Search Candidates inputs
Property Type Description
email Email string
The candidate's email address to search by
Optional
name Name string
The candidate's name to search by
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
ashby-search-candidates
Version
0.0.3
App
Ashby
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes