# People Search — Apollo (API Key)

> 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…

- Key: `apollo_io-people-search`
- Type: Action (Read-only)
- Version: 0.0.2
- App: Apollo (API Key) (`apollo_io`) — https://pipedream.com/apps/apollo-io.md
- This page (HTML): https://pipedream.com/apps/apollo-io/actions/people-search
- Hints: read-only · open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/apollo_io/actions/people-search/people-search.mjs

## Description

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](https://docs.apollo.io/reference/people-api-search)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `personTitles` | `string[]` | No | Job titles to filter on (matches against current titles). Example: ["sales manager", "engineering manager"] |
| `includeSimilarTitles` | `boolean` | No | When true, Apollo also matches semantically similar titles. Defaults to true on Apollo's side. |
| `personLocations` | `string[]` | No | Cities, US states, or countries where people live. Example: ["california", "chicago", "united kingdom"] |
| `personSeniorities` | `string[]` | No | Seniority levels. Allowed values: owner, founder, c_suite, partner, vp, head, director, manager, senior, entry, intern |
| `contactEmailStatus` | `string[]` | No | Email verification status. Allowed values: verified, unverified, likely to engage, unavailable |
| `qKeywords` | `string` | No | Free-text keywords to match across names, titles, and companies |
| `organizationIds` | `string[]` | No | Apollo organization IDs the person currently works at Options are loaded from the connected account. |
| `organizationNumEmployeesRanges` | `string[]` | No | Employee count ranges for the person's current company, formatted as min,max. Example: ["1,10", "250,500"] |
| `organizationLocations` | `string[]` | No | HQ locations of the person's current company. Example: ["texas", "tokyo", "spain"] |
| `organizationNotLocations` | `string[]` | No | Locations to EXCLUDE the person's current company from |
| `qOrganizationDomainsList` | `string[]` | No | Company domains to match (no www, no @). Example: ["apollo.io", "google.com"] |
| `qOrganizationKeywordTags` | `string[]` | No | Keyword tags describing the company industry/focus. Example: ["sales strategy", "lead generation"] |
| `currentlyUsingAnyOfTechnologyUids` | `string[]` | No | Apollo technology UIDs the company uses. Example: ["salesforce", "google_analytics"] |
| `revenueRangeMin` | `integer` | No | Minimum annual revenue (USD) for the person's company |
| `revenueRangeMax` | `integer` | No | Maximum annual revenue (USD) for the person's company |
| `qOrganizationJobTitles` | `string[]` | No | Job posting titles the person's company is hiring for |
| `organizationJobLocations` | `string[]` | No | Locations of job postings at the person's company |
| `organizationNumJobsMin` | `integer` | No | Minimum number of open job postings at the company |
| `organizationNumJobsMax` | `integer` | No | Maximum number of open job postings at the company |
| `organizationJobPostedAtMin` | `string` | No | Earliest date a job at the company was posted (YYYY-MM-DD) |
| `organizationJobPostedAtMax` | `string` | No | Latest date a job at the company was posted (YYYY-MM-DD) |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
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 accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_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": "apollo_io",
      },
    },
  },
)

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: "apollo_io-people-search",
  arguments: {
    personTitles: ["Person Titles"],
    includeSimilarTitles: true,
  },
})
```

**TypeScript**

```ts
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)
```

**cURL**

```bash
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": "apollo_io-people-search",
    "configured_props": {
      "apollo_io": { "authProvisionId": "apn_xxxxxxx" },
      "personTitles": ["Person Titles"],
      "includeSimilarTitles": true
    }
  }'
```

---

- App: https://pipedream.com/apps/apollo-io.md · All apps: https://pipedream.com/apps