> ## 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 Bulk People Enrichment: Inputs, Cost & CLI Example

> Matching and enriching multiple people in one request. Includes inputs, outputs, pricing notes, Deepline CLI examples, and GTM automation guidance.

## Run in Enrichment Spreadsheet

<Info>
  Use this function as a column step in `deepline enrich`.
</Info>

```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=apollo_bulk_people_enrichment:{"details":[{"first_name":"Jane","last_name":"Doe","email":"jane.doe@example.com","domain":"example.com"}]}' --json
```

<Tip>
  Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
</Tip>

## Input Schema

| Name                             | Type      | Required | Default | Description                                                       |
| -------------------------------- | --------- | -------- | ------- | ----------------------------------------------------------------- |
| `payload.run_waterfall_email`    | `boolean` | No       |         | When true, run waterfall email enrichment; requires webhook\_url. |
| `payload.run_waterfall_phone`    | `boolean` | No       |         | When true, run waterfall phone enrichment; requires webhook\_url. |
| `payload.reveal_personal_emails` | `boolean` | No       |         | When true, request personal email reveal (credit-consuming).      |
| `payload.reveal_phone_number`    | `boolean` | No       |         | When true, request phone reveal; requires webhook\_url.           |
| `payload.webhook_url`            | `string`  | No       |         | Webhook endpoint for async phone/waterfall results.               |
| `payload.details`                | `array`   | Yes      |         | People detail objects to enrich (1-10 items).                     |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Apollo bulk people enrichment input.",
    "properties": {
      "run_waterfall_email": {
        "type": "boolean",
        "description": "When true, run waterfall email enrichment; requires webhook_url."
      },
      "run_waterfall_phone": {
        "type": "boolean",
        "description": "When true, run waterfall phone enrichment; requires webhook_url."
      },
      "reveal_personal_emails": {
        "type": "boolean",
        "description": "When true, request personal email reveal (credit-consuming)."
      },
      "reveal_phone_number": {
        "type": "boolean",
        "description": "When true, request phone reveal; requires webhook_url."
      },
      "webhook_url": {
        "type": "string",
        "description": "Webhook endpoint for async phone/waterfall results."
      },
      "details": {
        "type": "array",
        "description": "People detail objects to enrich (1-10 items).",
        "items": {
          "type": "object",
          "properties": {
            "first_name": {
              "type": "string",
              "description": "Person's first name."
            },
            "last_name": {
              "type": "string",
              "description": "Person's last name."
            },
            "name": {
              "type": "string",
              "description": "Person's full name."
            },
            "email": {
              "type": "string",
              "description": "Person's email address."
            },
            "hashed_email": {
              "type": "string",
              "description": "Person's MD5-hashed email address."
            },
            "organization_name": {
              "type": "string",
              "description": "Employer/company name."
            },
            "domain": {
              "type": "string",
              "description": "Company domain (e.g., 'apollo.io')."
            },
            "id": {
              "type": "string",
              "description": "Apollo person ID from a prior lookup."
            },
            "linkedin_url": {
              "type": "string",
              "description": "Person's LinkedIn profile URL."
            }
          },
          "additionalProperties": false
        }
      }
    },
    "required": [
      "details"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output Schema

| Name          | Type     | Required | Default | Description                                                                     |
| ------------- | -------- | -------- | ------- | ------------------------------------------------------------------------------- |
| `result.data` | `object` | Yes      |         | Apollo bulk people payload with a top-level `matches` array and batch metadata. |
| `result.meta` | `record` | No       |         | Additional response metadata (status, paging).                                  |

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

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Apollo bulk people enrichment result.",
    "properties": {
      "data": {
        "type": [
          "object",
          "null"
        ],
        "description": "Apollo bulk people payload with a top-level `matches` array and batch metadata.",
        "properties": {
          "status": {
            "type": "string"
          },
          "error_code": {
            "type": [
              "string",
              "null"
            ]
          },
          "error_message": {
            "type": [
              "string",
              "null"
            ]
          },
          "total_requested_enrichments": {
            "type": "number"
          },
          "unique_enriched_records": {
            "type": "number"
          },
          "missing_records": {
            "type": "number"
          },
          "matches": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "first_name": {
                  "type": "string"
                },
                "last_name": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "linkedin_url": {
                  "type": "string"
                },
                "title": {
                  "type": "string"
                },
                "email": {
                  "type": "string"
                },
                "email_status": {
                  "type": "string"
                },
                "organization_id": {
                  "type": "string"
                }
              },
              "additionalProperties": false
            }
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": {}
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Advanced: Direct CLI

<Info>
  Use direct execution for single payload debugging.
</Info>

```bash theme={null}
deepline tools execute apollo_bulk_people_enrichment --payload '{
  "details": [
    {
      "first_name": "Jane",
      "last_name": "Doe",
      "email": "jane.doe@example.com",
      "domain": "example.com"
    }
  ]
}' --json
```

### CLI flags

| Flag                        | Description                                         |
| --------------------------- | --------------------------------------------------- |
| `--json`                    | Print machine-readable output.                      |
| `--wait`                    | Wait for terminal provider status when supported.   |
| `--debug`                   | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS`    | Max seconds to wait in wait mode.                   |
| `--poll-interval SECONDS`   | Polling interval in seconds during wait mode.       |
| `--timeout SECONDS`         | Request timeout in seconds.                         |
| `--connect-timeout SECONDS` | Connection timeout in seconds.                      |

## Cost

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