View as Markdown
Apollo (API Key) icon

Apollo (API Key) ACTION

People Search

Find people in the Apollo database using filters such as titles, seniorities, locations, technologies, and employer attributes. Requires a master API key. Use Search For Organizations first to find Apollo organization IDs you want to filter by. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Apollo (API Key) 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: "apollo_io-people-search",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    apollo_io: { authProvisionId: "apn_xxxxxxx" },
    personTitles: ["Person Titles"],
    includeSimilarTitles: true,
  },
})

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
personTitles Person Titles string[]
Job titles to filter on (matches against current titles). Example: ["sales manager", "engineering manager"]
Optional
includeSimilarTitles Include Similar Titles boolean
When true, Apollo also matches semantically similar titles. Defaults to true on Apollo's side.
Optional
personLocations Person Locations string[]
Cities, US states, or countries where people live. Example: ["california", "chicago", "united kingdom"]
Optional
personSeniorities Person Seniorities string[]
Seniority levels. Allowed values: owner, founder, c_suite, partner, vp, head, director, manager, senior, entry, intern
Optional
contactEmailStatus Contact Email Status string[]
Email verification status. Allowed values: verified, unverified, likely to engage, unavailable
Optional
qKeywords Keywords string
Free-text keywords to match across names, titles, and companies
Optional
organizationIds Organization IDs string[]
Apollo organization IDs the person currently works at
Optional Dynamic
organizationNumEmployeesRanges Organization Employee Ranges string[]
Employee count ranges for the person's current company, formatted as min,max. Example: ["1,10", "250,500"]
Optional
organizationLocations Organization Locations string[]
HQ locations of the person's current company. Example: ["texas", "tokyo", "spain"]
Optional
organizationNotLocations Excluded Organization Locations string[]
Locations to EXCLUDE the person's current company from
Optional
qOrganizationDomainsList Organization Domains string[]
Company domains to match (no www, no @). Example: ["apollo.io", "google.com"]
Optional
qOrganizationKeywordTags Organization Keyword Tags string[]
Keyword tags describing the company industry/focus. Example: ["sales strategy", "lead generation"]
Optional
currentlyUsingAnyOfTechnologyUids Technologies (UIDs) string[]
Apollo technology UIDs the company uses. Example: ["salesforce", "google_analytics"]
Optional
revenueRangeMin Revenue Range Min integer
Minimum annual revenue (USD) for the person's company
Optional
revenueRangeMax Revenue Range Max integer
Maximum annual revenue (USD) for the person's company
Optional
qOrganizationJobTitles Org Job Posting Titles string[]
Job posting titles the person's company is hiring for
Optional
organizationJobLocations Org Job Posting Locations string[]
Locations of job postings at the person's company
Optional
organizationNumJobsMin Org Open Jobs Min integer
Minimum number of open job postings at the company
Optional
organizationNumJobsMax Org Open Jobs Max integer
Maximum number of open job postings at the company
Optional
organizationJobPostedAtMin Org Job Posted After string
Earliest date a job at the company was posted (YYYY-MM-DD)
Optional
organizationJobPostedAtMax Org Job Posted Before string
Latest date a job at the company was posted (YYYY-MM-DD)
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
apollo_io-people-search
Version
0.0.2
App
Apollo (API Key)
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes