> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Apollo: Search People With Match

> Search people by job title, seniority, location, and company domain, then automatically enrich each match with full name, email, and LinkedIn profile.

Search people by job title, seniority, location, and company domain, then automatically enrich each match with full name, email, and LinkedIn profile.

> [!NOTE]
>
> Tool ID: `apollo_search_people_with_match`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'apollo_search_people_with_match',
  {
    "page": 123,
    "per_page": 123,
    "person_titles": [
      "example"
    ]
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute apollo_search_people_with_match --input '{
  "page": 123,
  "per_page": 123,
  "person_titles": [
    "example"
  ]
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "search": {
      "total_entries": 123,
      "people": [
        {}
      ],
      "pagination": {}
    },
    "people": [
      {}
    ],
    "total_candidates": 123
  }
}
```

Use `deepline describe apollo_search_people_with_match --json` for the latest machine-readable contract.

## Input reference

Prospect people from Apollo's global dataset, then automatically enrich the discovered IDs. This first runs no-credit preview search (`mixed_people/api_search`) and then paid bulk match on the returned people, so use it when you want search coverage but need fully enriched person rows back in one step.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.page` | `integer` | No | — | Page number (1-500). |
| `payload.per_page` | `integer` | No | — | Results per page (1-100). |
| `payload.person_titles` | `array` | No | — | Job titles to match. |
| `payload.include_similar_titles` | `boolean` | No | `true` | Include similar titles for person\_titles matches. |
| `payload.person_seniorities` | `array` | No | — | Seniority filter values defined by Apollo. |
| `payload.person_locations` | `array` | No | — | Person locations. |
| `payload.organization_locations` | `array` | No | — | Organization HQ locations. |
| `payload.organization_num_employees_ranges` | `array` | No | — | Employee ranges accepted by the Apollo search contract, for example '51,200' or '201,500'. |
| `payload.q_organization_domains_list` | `array` | No | — | Organization domains to include. |
| `payload.contact_email_status` | `array` | No | — | Email status values (e.g., 'verified', 'guessed'). |
| `payload.organization_ids` | `array` | No | — | Apollo organization IDs to include. |
| `payload.q_keywords` | `string` | No | — | Keyword query across person and organization fields. |
| `payload.revenue_range` | `object` | No | — | Inclusive numeric range. |
| `payload.currently_using_any_of_technology_uids` | `array` | No | — | Organizations using ANY of these technology UIDs. |
| `payload.currently_using_all_of_technology_uids` | `array` | No | — | Organizations using ALL of these technology UIDs. |
| `payload.currently_not_using_any_of_technology_uids` | `array` | No | — | Exclude organizations using ANY of these technology UIDs. |
| `payload.q_organization_job_titles` | `array` | No | — | Organizations hiring for these job titles. |
| `payload.organization_job_locations` | `array` | No | — | Organizations hiring in these locations. |
| `payload.organization_num_jobs_range` | `object` | No | — | Inclusive integer range. |
| `payload.organization_job_posted_at_range` | `object` | No | — | Inclusive date range. |
| `payload.reveal_personal_emails` | `boolean` | No | `false` | When true, attempt personal email reveal during auto-match enrichment. WARNING: Apollo primarily returns work emails even with this flag (\~70% work, \~30% personal). Do NOT use Apollo for personal email discovery - use Fullenrich or BetterContact instead. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Prospect people from Apollo's global dataset, then automatically enrich the discovered IDs. This first runs no-credit preview search (`mixed_people/api_search`) and then paid bulk match on the returned people, so use it when you want search coverage but need fully enriched person rows back in one step.",
    "properties": {
      "page": {
        "type": "integer",
        "description": "Page number (1-500)."
      },
      "per_page": {
        "type": "integer",
        "description": "Results per page (1-100)."
      },
      "person_titles": {
        "type": "array",
        "description": "Job titles to match.",
        "items": {
          "type": "string"
        }
      },
      "include_similar_titles": {
        "type": "boolean",
        "description": "Include similar titles for person_titles matches.",
        "default": true
      },
      "person_seniorities": {
        "type": "array",
        "description": "Seniority filter values defined by Apollo.",
        "items": {
          "type": "string",
          "description": "Apollo person seniority value.",
          "enum": [
            "owner",
            "founder",
            "c_suite",
            "partner",
            "vp",
            "head",
            "director",
            "manager",
            "senior",
            "entry",
            "intern"
          ]
        }
      },
      "person_locations": {
        "type": "array",
        "description": "Person locations.",
        "items": {
          "type": "string"
        }
      },
      "organization_locations": {
        "type": "array",
        "description": "Organization HQ locations.",
        "items": {
          "type": "string"
        }
      },
      "organization_num_employees_ranges": {
        "type": "array",
        "description": "Employee ranges accepted by the Apollo search contract, for example '51,200' or '201,500'.",
        "items": {
          "type": "string"
        }
      },
      "q_organization_domains_list": {
        "type": "array",
        "description": "Organization domains to include.",
        "items": {
          "type": "string"
        }
      },
      "contact_email_status": {
        "type": "array",
        "description": "Email status values (e.g., 'verified', 'guessed').",
        "items": {
          "type": "string"
        }
      },
      "organization_ids": {
        "type": "array",
        "description": "Apollo organization IDs to include.",
        "items": {
          "type": "string"
        }
      },
      "q_keywords": {
        "type": "string",
        "description": "Keyword query across person and organization fields."
      },
      "revenue_range": {
        "type": "object",
        "description": "Inclusive numeric range.",
        "properties": {
          "min": {
            "type": "number",
            "description": "Minimum numeric value."
          },
          "max": {
            "type": "number",
            "description": "Maximum numeric value."
          }
        },
        "additionalProperties": false
      },
      "currently_using_any_of_technology_uids": {
        "type": "array",
        "description": "Organizations using ANY of these technology UIDs.",
        "items": {
          "type": "string"
        }
      },
      "currently_using_all_of_technology_uids": {
        "type": "array",
        "description": "Organizations using ALL of these technology UIDs.",
        "items": {
          "type": "string"
        }
      },
      "currently_not_using_any_of_technology_uids": {
        "type": "array",
        "description": "Exclude organizations using ANY of these technology UIDs.",
        "items": {
          "type": "string"
        }
      },
      "q_organization_job_titles": {
        "type": "array",
        "description": "Organizations hiring for these job titles.",
        "items": {
          "type": "string"
        }
      },
      "organization_job_locations": {
        "type": "array",
        "description": "Organizations hiring in these locations.",
        "items": {
          "type": "string"
        }
      },
      "organization_num_jobs_range": {
        "type": "object",
        "description": "Inclusive integer range.",
        "properties": {
          "min": {
            "type": "integer",
            "description": "Minimum integer value."
          },
          "max": {
            "type": "integer",
            "description": "Maximum integer value."
          }
        },
        "additionalProperties": false
      },
      "organization_job_posted_at_range": {
        "type": "object",
        "description": "Inclusive date range.",
        "properties": {
          "min": {
            "type": "string",
            "description": "Minimum date/time (ISO 8601)."
          },
          "max": {
            "type": "string",
            "description": "Maximum date/time (ISO 8601)."
          }
        },
        "additionalProperties": false
      },
      "reveal_personal_emails": {
        "type": "boolean",
        "description": "When true, attempt personal email reveal during auto-match enrichment. WARNING: Apollo primarily returns work emails even with this flag (~70% work, ~30% personal). Do NOT use Apollo for personal email discovery - use Fullenrich or BetterContact instead.",
        "default": false
      }
    },
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Apollo no-credit preview search + paid auto-match result. Uses no-credit `/mixed_people/api_search` for discovery, then paid `/people/bulk_match` for returned IDs. Use `result.data.people` (or `&lt;column&gt;.data.people`) as the enriched contact list.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Composite payload with `search` preview metadata and enriched `people` matches. |
| `result.data.search` | `object \| null` | No | — | Apollo native people-search payload. Shape is top-level `&#123; total_entries, people, pagination &#125;`. Important: results may include obfuscated last names (e.g., `last_name_obfuscated`). Do not build email patterns from obfuscated names. Use `apollo_bulk_people_enrichment` with `details: [&#123; id &#125;]` to retrieve full contact fields from Apollo person IDs. |
| `result.data.search.total_entries` | `number` | No | — | Total number of matching people records. |
| `result.data.search.people` | `array` | No | — | — |
| `result.data.search.pagination` | `record` | No | — | — |
| `result.data.people` | `array` | No | — | — |
| `result.data.total_candidates` | `number` | No | — | — |
| `result.data.attempted_matches` | `number` | No | — | — |
| `result.data.unique_enriched_records` | `number` | No | — | — |
| `result.data.missing_records` | `number` | No | — | — |
| `result.meta` | `record` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Apollo no-credit preview search + paid auto-match result. Uses no-credit `/mixed_people/api_search` for discovery, then paid `/people/bulk_match` for returned IDs. Use `result.data.people` (or `<column>.data.people`) as the enriched contact list.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Composite payload with `search` preview metadata and enriched `people` matches.",
        "properties": {
          "search": {
            "type": [
              "object",
              "null"
            ],
            "description": "Apollo native people-search payload. Shape is top-level `{ total_entries, people, pagination }`. Important: results may include obfuscated last names (e.g., `last_name_obfuscated`). Do not build email patterns from obfuscated names; use `apollo_bulk_people_enrichment` with `details: [{ id }]` to retrieve full contact fields from Apollo person IDs.",
            "properties": {
              "total_entries": {
                "type": "number",
                "description": "Total number of matching people records."
              },
              "people": {
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": {}
                }
              },
              "pagination": {
                "type": "object",
                "additionalProperties": {}
              }
            },
            "additionalProperties": false
          },
          "people": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": {}
            }
          },
          "total_candidates": {
            "type": "number"
          },
          "attempted_matches": {
            "type": "number"
          },
          "unique_enriched_records": {
            "type": "number"
          },
          "missing_records": {
            "type": "number"
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": {}
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `per_result` (per result).
* Estimated Deepline credits: `0.17` per pricing unit.

## Related documentation

* [Apollo provider guide](https://deepline.com/docs/providers/apollo/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.