View as Markdown
ContactOut icon

ContactOut ACTION

People Search

Search for people based on various criteria like name, company, title, location, skills, and more. See the documentation.
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's ContactOut account once, then configure and run People Search 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: "contactout-people-search",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    contactout: { authProvisionId: "apn_xxxxxxx" },
    name: "Name",
    jobTitle: ["Job Titles"],
  },
})

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.

People Search inputs
Property Type Description
name Name string
Name of the profile to search for
Optional
jobTitle Job Titles string[]
Array of job titles to search for (max 50)
Optional
currentTitlesOnly Current Titles Only boolean
Returns profiles matching the current job title only
Optional
includeRelatedJobTitles Include Related Job Titles boolean
Returns profiles with related job titles
Optional
matchExperience Match Experience string
Ensures Job Title and Company match in the same experience. If set, Current Titles Only and Company Filter should not be used. API will return an error in that case.
Optional
skills Skills string[]
Array of skills to search for (max 50). Supports boolean equations
Optional
education Education string[]
Array of schools/degrees to search for (max 50). Supports boolean equations
Optional
location Locations string[]
Array of locations to search for (max 50)
Optional
company Companies string[]
Array of company names to search for (max 50)
Optional
companyFilter Company Filter string
Filter by current or past company experience
Optional
currentCompanyOnly Current Company Only boolean
Returns profiles matching the current company name only
Optional
domain Domains string[]
Array of company domains to search for (max 50)
Optional
industry Industries string[]
Array of industries to search for (max 50). Supports boolean equations
Optional
keyword Keyword string
Returns profiles that contain the mentioned keyword anywhere in their profile
Optional
companySize Company Sizes string[]
Array of company size ranges
Optional
yearsOfExperience Years of Experience string[]
Array representing ranges of years of experience
Optional
yearsInCurrentRole Years in Current Role string[]
Array representing ranges of years in current role
Optional
page Page integer
Page number for pagination
Optional
dataTypes Data Types string[]
Returns profiles containing at least one of the specified data types
Optional
revealInfo Reveal Contact Info boolean
If set to true, contact_info will contain emails and phone numbers (credits will be charged)
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
contactout-people-search
Version
0.0.2
App
ContactOut
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes