Recruiterflow ACTION
Search Candidates
Searches for candidates matching specified criteria in Recruiterflow. Supports both simple searches and advanced filter arrays. See the documentation
- Action
- Read only
- Idempotent
- API key
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Recruiterflow 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: "recruiterflow-search-candidates",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
recruiterflow: { authProvisionId: "apn_xxxxxxx" },
conjunction: "Conjunction",
filters: ["Filters"],
},
})
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": "recruiterflow-search-candidates",
"configured_props": {
"recruiterflow": { "authProvisionId": "apn_xxxxxxx" },
"conjunction": "Conjunction",
"filters": ["Filters"]
}
}'// 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": "recruiterflow",
},
},
},
)
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: "recruiterflow-search-candidates",
arguments: {
conjunction: "Conjunction",
filters: ["Filters"],
},
})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 |
|---|---|---|
conjunction Conjunction | string | How to combine multiple filters Required |
filters Filters | string[] | Array of filter objects as JSON strings. Each filter should have type, key, and other properties based on filter type. Example: {"type": "text", "conjunction": "in", "values": ["John"], "key": "name"}. Leave empty to use simple search fields below. Optional |
itemsPerPage Items Per Page | integer | Number of results to return per page Required |
currentPage Current Page | integer | Page number to retrieve Required |
includeCount Include Count | boolean | Whether to include total count in response Optional |
name Name | string | Search by candidate name (simple search) Optional |
email Email | string | Search by candidate email (simple search) Optional |
textSearch Text Search | string | Search in resume, notes, emails, and files (simple search) Optional |
includeNotes Include Notes in Text Search | boolean | Include notes when using text search Optional |
includeFiles Include Files in Text Search | boolean | Include files when using text search Optional |
includeEmails Include Emails in Text Search | boolean | Include emails when using text search Optional |
skills Skills | string[] | Filter by skills (simple search) Optional |
jobTitle Job Title | string | Filter by job title (simple search) Optional |
currentCompany Current Company | string | Filter by current company (simple search) Optional |
phoneNumber Phone Number | string | Filter by phone number (simple search) Optional |
linkedinProfile LinkedIn Profile | string | Filter by LinkedIn profile URL (simple search) Optional |
school School | string | Filter by school (simple search) 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
- recruiterflow-search-candidates
- Version
- 0.0.2
- App
- Recruiterflow
- Authentication
- API key
- Read-only
- Yes
- Destructive
- No
- Idempotent
- Yes
- Open world
- Yes
- Source
- View on GitHub ↗