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

# Icypeas: Find Companies

> Search companies by name, industry, location, headcount range, company type, domain, and keyword. Returns each company with its LinkedIn URL.

Search companies by name, industry, location, headcount range, company type, domain, and keyword. Returns each company with its LinkedIn URL.

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

## 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(
  'icypeas_find_companies',
  {
    "query": {
      "name": {
        "include": [
          "example"
        ],
        "exclude": [
          "example"
        ]
      },
      "type": {
        "include": [
          "example"
        ],
        "exclude": [
          "example"
        ]
      },
      "industry": {
        "include": [
          "example"
        ],
        "exclude": [
          "example"
        ]
      }
    }
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute icypeas_find_companies --input '{
  "query": {
    "name": {
      "include": [
        "example"
      ],
      "exclude": [
        "example"
      ]
    },
    "type": {
      "include": [
        "example"
      ],
      "exclude": [
        "example"
      ]
    },
    "industry": {
      "include": [
        "example"
      ],
      "exclude": [
        "example"
      ]
    }
  }
}' --json
```

## Example response

The static output schema lacks the details for a reliable example. Use `deepline describe icypeas_find_companies --json` for the complete live contract.

## Input reference

Search the company database with structured filters.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.query` | `object` | Yes | — | Search filters for companies. |
| `payload.pagination` | `object` | No | — | Pagination parameters. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Search the company database with structured filters.",
    "properties": {
      "query": {
        "type": "object",
        "description": "Search filters for companies.",
        "properties": {
          "name": {
            "type": "object",
            "description": "Filter by company name.",
            "properties": {
              "include": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "exclude": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": false
          },
          "type": {
            "type": "object",
            "description": "Filter by company type.",
            "properties": {
              "include": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "exclude": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": false
          },
          "industry": {
            "type": "object",
            "description": "Filter by industry.",
            "properties": {
              "include": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "exclude": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": false
          },
          "location": {
            "type": "object",
            "description": "Filter by location.",
            "properties": {
              "include": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "exclude": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": false
          },
          "domain": {
            "type": "object",
            "description": "Filter by domain.",
            "properties": {
              "include": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "exclude": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": false
          },
          "keyword": {
            "type": "object",
            "description": "Filter by keyword.",
            "properties": {
              "include": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "exclude": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": false
          },
          "lid": {
            "type": "object",
            "description": "Filter by LinkedIn ID.",
            "properties": {
              "include": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "exclude": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": false
          },
          "urn": {
            "type": "object",
            "description": "Filter by LinkedIn URN.",
            "properties": {
              "include": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "exclude": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": false
          },
          "companyId": {
            "type": "object",
            "description": "Filter by Icypeas company ID.",
            "properties": {
              "include": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "exclude": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "additionalProperties": false
          },
          "headcount": {
            "type": "object",
            "description": "Filter by headcount range using >=, <, <=, > operators.",
            "properties": {
              ">=": {
                "type": "number"
              },
              "<": {
                "type": "number"
              },
              "<=": {
                "type": "number"
              },
              ">": {
                "type": "number"
              }
            },
            "additionalProperties": false
          }
        },
        "additionalProperties": false
      },
      "pagination": {
        "type": "object",
        "description": "Pagination parameters.",
        "properties": {
          "size": {
            "type": "integer",
            "description": "Page size (1-200)."
          },
          "token": {
            "type": "string",
            "description": "Cursor token from previous response for pagination."
          }
        },
        "additionalProperties": false
      }
    },
    "required": [
      "query"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `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={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "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>

## Deepline cost

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

## Related documentation

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