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

> Search companies by filters. 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=quickenrich_company_search:{}' --json
```

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

## Input Schema

| Name                          | Type      | Required | Default | Description                                               |
| ----------------------------- | --------- | -------- | ------- | --------------------------------------------------------- |
| `payload.page`                | `integer` | No       | `1`     |                                                           |
| `payload.per_page`            | `integer` | No       | `10`    |                                                           |
| `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={null}
  {
    "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 Schema

| Name          | Type     | Required | Default | Description                                    |
| ------------- | -------- | -------- | ------- | ---------------------------------------------- |
| `result.data` | `object` | Yes      |         | Provider response payload.                     |
| `result.meta` | `object` | 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.",
        "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>

## Advanced: Direct CLI

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

```bash theme={null}
deepline tools execute quickenrich_company_search --payload '{}' --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.06` per pricing unit.
* Billing mode: `post_deduct`.
