View as Markdown
Apollo (API Key) icon

Apollo (API Key) ACTION

People Enrichment

Enriches a person's information, the more information you pass in, the more likely we can find a match. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Apollo (API Key) account once, then configure and run People Enrichment 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-enrichment",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    apollo_io: { authProvisionId: "apn_xxxxxxx" },
    firstName: "First Name",
    lastName: "Last 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.

People Enrichment inputs
Property Type Description
firstName First Name string
The person's first name
Optional
lastName Last Name string
The person's last name
Optional
name Name string
The full name of the person
Optional
email Email string
The person's email
Optional
hashedEmail Hashed Email string
The hashed email of the person. The email should adhere to either the MD5 or SHA-256 hash format. Example: 8d935115b9ff4489f2d1f9249503cadf (MD5) or 97817c0c49994eb500ad0a5e7e2d8aed51977b26424d508f66e4e8887746a152 (SHA-256)
Optional
organizationName Organization Name string
The person's company name
Optional
domain Domain string
The domain name for the person's employer. This can be the current employer or a previous employer. Do not include www., the @ symbol, or similar. Example: apollo.io or microsoft.com
Optional
personId Person ID string
The Apollo ID for the person
Optional Dynamic
linkedinUrl LinkedIn URL string
The URL for the person's LinkedIn profile
Optional
revealPersonalEmails Reveal Personal Emails boolean
Set to true if you want to enrich the person's data with personal emails
Optional
revealPhoneNumber Reveal Phone Number boolean
Set to true if you want to enrich the person's data with all available phone numbers, including mobile phone numbers
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-enrichment
Version
0.0.10
App
Apollo (API Key)
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes