> ## 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.

# Bulk Work Email Search with Icypeas

> Use Icypeas as a bulk email finder for multiple people, supply names and company identifiers, then retrieve job status and work-email enrichment results.

## Quick answer

Use Icypeas bulk search when you have multiple people and company identifiers and want one asynchronous work-email enrichment job.

## 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=icypeas_bulk_search:{"name":"{{name}}","task":"email-search","data":"{{data}}"}' --json
```

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

## Input Schema

| Name           | Type                                                        | Required | Default | Description                                                                                              |
| -------------- | ----------------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------- |
| `payload.name` | `string`                                                    | Yes      |         | Name for this bulk search job.                                                                           |
| `payload.task` | `"email-search" \| "email-verification" \| "domain-search"` | Yes      |         | Type of search to perform in bulk.                                                                       |
| `payload.data` | `array`                                                     | Yes      |         | Rows of data. Format depends on task type (for example \[firstname, lastname, domain] for email-search). |

### Allowed values

| Field          | Allowed values                                        |
| -------------- | ----------------------------------------------------- |
| `payload.task` | `email-search`, `email-verification`, `domain-search` |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Submit a batch of up to 5,000 searches. Monitor via read-bulk-files.",
    "properties": {
      "name": {
        "type": "string",
        "description": "Name for this bulk search job."
      },
      "task": {
        "type": "string",
        "description": "Type of search to perform in bulk.",
        "enum": [
          "email-search",
          "email-verification",
          "domain-search"
        ]
      },
      "data": {
        "type": "array",
        "description": "Rows of data. Format depends on task type (for example [firstname, lastname, domain] for email-search).",
        "items": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "required": [
      "name",
      "task",
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output Schema

| Name          | Type     | Required | Default | Description                                    |
| ------------- | -------- | -------- | ------- | ---------------------------------------------- |
| `result.data` | `record` | Yes      |         | Provider response payload.                     |
| `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": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "additionalProperties": {}
      },
      "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 icypeas_bulk_search --payload '{
  "name": "string",
  "task": "email-search",
  "data": "array"
}' --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.14` per pricing unit.
* Billing mode: `pre_reserve`.