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

# QuickEnrich: Company Search

> Find companies matching filters like name, website, location, industry, size, revenue and services. Includes SDK V2 examples, schemas, and cost.

Find companies matching filters like name, website, location, industry, size, revenue and services.

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

## 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(
  'quickenrich_company_search',
  {
    "page": 1,
    "per_page": 10,
    "include_full_text": true
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute quickenrich_company_search --input '{
  "page": 1,
  "per_page": 10,
  "include_full_text": true
}' --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": {
    "success": true,
    "message": "Example message",
    "code": 123
  }
}
```

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

## Input reference

Filter-based company search. At least one filter is required. `company_url` supports include only (exclude is rejected). Constrained dimensions (`country_code`, `number_of_employees`, `revenue`, `services`, `industry`) must use exact lookup values.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.page` | `integer` | No | `1` | Minimum: 1. |
| `payload.per_page` | `integer` | No | `10` | Minimum: 1. Maximum: 100. |
| `payload.include_full_text` | `boolean` | No | — | When true, include full home\_page\_text on each company. |
| `payload.company_name` | `object` | No | — | — |
| `payload.company_url` | `object` | No | — | Include only. exclude is not supported. |
| `payload.city` | `object` | No | — | — |
| `payload.country_code` | `object` | No | — | — |
| `payload.number_of_employees` | `object` | No | — | — |
| `payload.revenue` | `object` | No | — | — |
| `payload.industry` | `object` | No | — | — |
| `payload.services` | `object` | No | — | — |
| `payload.home_page_text` | `object` | No | — | — |
| `payload.bio_li` | `object` | No | — | — |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Filter-based company search. At least one filter is required. `company_url` supports include only (exclude is rejected). Constrained dimensions (`country_code`, `number_of_employees`, `revenue`, `services`, `industry`) must use exact lookup values.",
    "properties": {
      "page": {
        "type": "integer",
        "default": 1,
        "minimum": 1
      },
      "per_page": {
        "type": "integer",
        "default": 10,
        "minimum": 1,
        "maximum": 100
      },
      "include_full_text": {
        "type": "boolean",
        "description": "When true, include full home_page_text on each company."
      },
      "company_name": {
        "type": "object",
        "properties": {
          "include": {
            "type": "array",
            "maxItems": 50,
            "items": {
              "type": "string"
            }
          },
          "exclude": {
            "type": "array",
            "maxItems": 50,
            "items": {
              "type": "string"
            }
          }
        },
        "additionalProperties": false
      },
      "company_url": {
        "type": "object",
        "description": "Include only; exclude is not supported.",
        "properties": {
          "include": {
            "type": "array",
            "maxItems": 50,
            "items": {
              "type": "string"
            }
          }
        },
        "additionalProperties": false
      },
      "city": {
        "type": "object",
        "properties": {
          "include": {
            "type": "array",
            "maxItems": 50,
            "items": {
              "type": "string"
            }
          },
          "exclude": {
            "type": "array",
            "maxItems": 50,
            "items": {
              "type": "string"
            }
          }
        },
        "additionalProperties": false
      },
      "country_code": {
        "type": "object",
        "properties": {
          "include": {
            "type": "array",
            "maxItems": 50,
            "items": {
              "type": "string"
            }
          },
          "exclude": {
            "type": "array",
            "maxItems": 50,
            "items": {
              "type": "string"
            }
          }
        },
        "additionalProperties": false
      },
      "number_of_employees": {
        "type": "object",
        "properties": {
          "include": {
            "type": "array",
            "maxItems": 50,
            "items": {
              "type": "string"
            }
          },
          "exclude": {
            "type": "array",
            "maxItems": 50,
            "items": {
              "type": "string"
            }
          }
        },
        "additionalProperties": false
      },
      "revenue": {
        "type": "object",
        "properties": {
          "include": {
            "type": "array",
            "maxItems": 50,
            "items": {
              "type": "string"
            }
          },
          "exclude": {
            "type": "array",
            "maxItems": 50,
            "items": {
              "type": "string"
            }
          }
        },
        "additionalProperties": false
      },
      "industry": {
        "type": "object",
        "properties": {
          "include": {
            "type": "array",
            "maxItems": 50,
            "items": {
              "type": "string"
            }
          },
          "exclude": {
            "type": "array",
            "maxItems": 50,
            "items": {
              "type": "string"
            }
          }
        },
        "additionalProperties": false
      },
      "services": {
        "type": "object",
        "properties": {
          "include": {
            "type": "array",
            "maxItems": 50,
            "items": {
              "type": "string"
            }
          },
          "exclude": {
            "type": "array",
            "maxItems": 50,
            "items": {
              "type": "string"
            }
          }
        },
        "additionalProperties": false
      },
      "home_page_text": {
        "type": "object",
        "properties": {
          "include": {
            "type": "array",
            "maxItems": 50,
            "items": {
              "type": "string"
            }
          },
          "exclude": {
            "type": "array",
            "maxItems": 50,
            "items": {
              "type": "string"
            }
          }
        },
        "additionalProperties": false
      },
      "bio_li": {
        "type": "object",
        "properties": {
          "include": {
            "type": "array",
            "maxItems": 50,
            "items": {
              "type": "string"
            }
          },
          "exclude": {
            "type": "array",
            "maxItems": 50,
            "items": {
              "type": "string"
            }
          }
        },
        "additionalProperties": false
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.success` | `boolean` | Yes | — | — |
| `result.data.message` | `string` | Yes | — | — |
| `result.data.code` | `integer` | Yes | — | — |
| `result.data.data` | `array` | No | — | — |
| `result.data.data[].document_id` | `string \| null` | No | — | — |
| `result.data.data[].company_name` | `string \| null` | No | — | — |
| `result.data.data[].url` | `string \| null` | No | — | — |
| `result.data.data[].email_domain` | `string \| null` | No | — | — |
| `result.data.data[].final_email_domain` | `string \| null` | No | — | — |
| `result.data.data[].home_page_email` | `string \| null` | No | — | — |
| `result.data.data[].phone` | `string \| null` | No | — | — |
| `result.data.data[].linkedin_url` | `string \| null` | No | — | — |
| `result.data.data[].city` | `string \| null` | No | — | — |
| `result.data.data[].region_code` | `string \| null` | No | — | — |
| `result.data.data[].country_code` | `string \| null` | No | — | — |
| `result.data.data[].industry` | `string \| null` | No | — | — |
| `result.data.data[].employee_count` | `string \| null` | No | — | — |
| `result.data.data[].revenue` | `string \| null` | No | — | — |
| `result.data.data[].services` | `array` | No | — | — |
| `result.data.data[].service_count` | `integer` | No | — | — |
| `result.data.data[].home_page_text_snippet` | `string \| null` | No | — | — |
| `result.data.data[].bio_li_snippet` | `string \| null` | No | — | — |
| `result.data.data[].home_page_text` | `string \| null` | No | — | Only present when include\_full\_text=true |
| `result.data.meta` | `object` | No | — | — |
| `result.data.meta.page` | `integer` | No | — | — |
| `result.data.meta.per_page` | `integer` | No | — | — |
| `result.data.meta.total` | `integer` | No | — | — |
| `result.data.meta.last_page` | `integer` | No | — | — |
| `result.data.meta.reason` | `string` | No | — | — |
| `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": {
          "success": {
            "type": "boolean"
          },
          "message": {
            "type": "string"
          },
          "code": {
            "type": "integer"
          },
          "data": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "document_id": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "company_name": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "url": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "email_domain": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "final_email_domain": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "home_page_email": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "phone": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "linkedin_url": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "city": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "region_code": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "country_code": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "industry": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "employee_count": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "revenue": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "services": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "service_count": {
                  "type": "integer"
                },
                "home_page_text_snippet": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "bio_li_snippet": {
                  "type": [
                    "string",
                    "null"
                  ]
                },
                "home_page_text": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "Only present when include_full_text=true"
                }
              },
              "additionalProperties": false
            }
          },
          "meta": {
            "type": "object",
            "properties": {
              "page": {
                "type": "integer"
              },
              "per_page": {
                "type": "integer"
              },
              "total": {
                "type": "integer"
              },
              "last_page": {
                "type": "integer"
              },
              "reason": {
                "type": "string"
              }
            },
            "additionalProperties": false
          }
        },
        "required": [
          "success",
          "message",
          "code"
        ],
        "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.06` per pricing unit.

## Related documentation

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