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

# Findymail: Search Leads

> Start an Intellimatch search: describe target companies and contacts in plain language to build a lead list. Returns a hash to poll for results.

Start an Intellimatch search: describe target companies and contacts in plain language to build a lead list.

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

## 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(
  'findymail_search_leads',
  {
    "query": "software companies hiring engineers"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute findymail_search_leads --input '{
  "query": "software companies hiring engineers"
}' --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": {
    "hash": "example"
  }
}
```

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

## Input reference

Create an Intellimatch search task. Intellimatch is Findymail’s intelligent company search tool that lets you build highly targeted lead lists using plain language queries. Instead of manually applying filters or reviewing websites one by one, Intellimatch uses real-time semantic search to find the best-fit companies and contacts. The API responds immediately with a `hash` identifying the task for polling completion status. Please check [https://help.findymail.com/en/article/what-is-supported-in-intellimatch-15s0u10/](https://help.findymail.com/en/article/what-is-supported-in-intellimatch-15s0u10/) for more information about what is supported or not.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.query` | `string` | Yes | — | The search query describing target companies. |
| `payload.limit` | `integer` | No | — | The maximum number of companies to export (default: 100, max: 5000). |
| `payload.config` | `object` | No | — | Export configuration (all fields are optional). |
| `payload.wait_for_completion` | `boolean` | No | `true` | When true or omitted, wait for the Intellimatch export to finish and return result rows. Set false to return only the async launcher response. |
| `payload.poll_interval_ms` | `integer` | No | `2000` | Polling interval used while wait\_for\_completion is true. Defaults to 2000 ms. Minimum: 250. Maximum: 10000. |
| `payload.max_wait_ms` | `integer` | No | `45000` | Maximum time to wait for terminal Findymail results. Defaults to 45000 ms. Minimum: 1000. Maximum: 120000. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Create an Intellimatch search task. Intellimatch is Findymail’s intelligent company search tool that lets you build highly targeted lead lists using plain language queries. Instead of manually applying filters or reviewing websites one by one, Intellimatch uses real-time semantic search to find the best-fit companies and contacts. The API responds immediately with a `hash` identifying the task for polling completion status. Please check https://help.findymail.com/en/article/what-is-supported-in-intellimatch-15s0u10/ for more information about what is supported or not.",
    "properties": {
      "query": {
        "type": "string",
        "description": "The search query describing target companies."
      },
      "limit": {
        "type": "integer",
        "description": "The maximum number of companies to export (default: 100, max: 5000)."
      },
      "config": {
        "type": "object",
        "description": "Export configuration (all fields are optional).",
        "properties": {
          "find_contact": {
            "type": "boolean",
            "description": "Whether to find contacts (default: false)."
          },
          "find_email": {
            "type": "boolean",
            "description": "Whether to enrich contacts with email. (1 credit per email found) (default: false)."
          },
          "find_phone": {
            "type": "boolean",
            "description": "Whether to enrich contacts with phone number (10 credits per phone number found) (default: false)."
          },
          "target_job_titles": {
            "type": "array",
            "description": "Target job titles for contacts. Variations that have the same intent (eg. \"CEO\" and \"Chief Executive Officer\") are already handled. (default: [\"CEO\"]).",
            "items": {
              "type": "string"
            }
          },
          "lead_list_id": {
            "type": "integer",
            "description": "Lead list ID to add contacts to."
          },
          "mode": {
            "type": "string",
            "description": "Export mode: \"broad\" or \"targeted\" (default: \"broad\")."
          },
          "require_email": {
            "type": "boolean",
            "description": "Only return companies where an email was found. Requires find_contact and find_email to be true. Companies without email are excluded and not charged. (default: false)."
          },
          "add_to_exclusion_list": {
            "type": "boolean",
            "description": "Add exported companies to exclusion list (default: false)."
          },
          "exclusion_list_id": {
            "type": "integer",
            "description": "Exclusion list ID where to add domains when add_to_exclusion_list is true."
          },
          "exclusion_filter_list_ids": {
            "type": "array",
            "description": "List of exclusion list IDs to filter results (default: [0] = global exclusion list, [-1] = no filter).",
            "items": {
              "type": "integer"
            }
          }
        },
        "additionalProperties": false
      },
      "wait_for_completion": {
        "type": "boolean",
        "description": "When true or omitted, wait for the Intellimatch export to finish and return result rows. Set false to return only the async launcher response.",
        "default": true
      },
      "poll_interval_ms": {
        "type": "integer",
        "description": "Polling interval used while wait_for_completion is true. Defaults to 2000 ms.",
        "default": 2000,
        "minimum": 250,
        "maximum": 10000
      },
      "max_wait_ms": {
        "type": "integer",
        "description": "Maximum time to wait for terminal Findymail results. Defaults to 45000 ms.",
        "default": 45000,
        "minimum": 1000,
        "maximum": 120000
      }
    },
    "required": [
      "query"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.hash` | `string` | No | — | Unique hash to track the export progress and retrieve results. |
| `result.meta` | `object` | 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": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "hash": {
            "type": "string",
            "description": "Unique hash to track the export progress and retrieve results."
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

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

## Related documentation

* [Findymail provider guide](https://deepline.com/docs/providers/findymail/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.