> ## 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.
# Fullenrich Company Search: Inputs, Cost & CLI Example
> Searching for companies by industry, headcount, domain, and location filters. Includes inputs, outputs, costs, and Deepline CLI examples for GTM automation.
## Run in Enrichment Spreadsheet
Use this function as a column step in `deepline enrich`.
```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=fullenrich_company_search:{}' --json
```
Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
## Input Schema
| Name | Type | Required | Default | Description |
| -------------------------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `payload.offset` | `integer` | No | | Number of companies to skip (use this for pagination). Maximum value is 10,000. To paginate beyond 10,000 results, use search\_after instead. |
| `payload.limit` | `integer` | No | | Number of companies to return (default: 10, max: 100) |
| `payload.search_after` | `string` | No | | Cursor-based pagination. Pass the search\_after value from the previous response to get the next page. Works at any point in the result set, but is required to access results beyond the 10,000 offset limit. |
| `payload.names` | `array` | No | | Filter by company names. Use exact\_match for precise company name matching. |
| `payload.domains` | `array` | No | | Filter by company domains (e.g., 'google.com', 'microsoft.com'). Exact match recommended. |
| `payload.linkedin_urls` | `array` | No | | Filter by LinkedIn URLs. |
| `payload.keywords` | `array` | No | | Filter by description of company |
| `payload.specialties` | `array` | No | | Filter by specialties of company |
| `payload.industries` | `array` | No | | Filter by company industries (e.g., 'Software Development', 'Computer Hardware Manufacturing', 'Housing and Community Development', 'Warehousing', 'Financial Services'). See [Industries](/docs/api/v2/general/enums#company-industry) for the full list. |
| `payload.types` | `array` | No | | Filter by company types (e.g., 'Public Company', 'Privately Held', 'Nonprofit', 'Self-Employed', 'Partnership', 'Educational', 'Government Agency'). See [Company Types](/docs/api/v2/general/enums#company-type) for the full list. |
| `payload.headquarters_locations` | `array` | No | | Filter by headquarters locations (city names, regions, or countries) |
| `payload.founded_years` | `array` | No | | Filter by founding years. Useful for targeting startups (recent years) or established companies. |
| `payload.headcounts` | `array` | No | | Filter by company headcounts (number of employees). Use ranges to target specific company sizes (e.g., startups: 1-50, mid-size: 50-500, enterprise: 1000+). |
| `payload.company_ids` | `array` | No | | Filter by specific company IDs |
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"type": "object",
"description": "Search for companies based on various filters. Multiple filters within the same field are combined with AND logic.",
"properties": {
"offset": {
"type": "integer",
"description": "Number of companies to skip (use this for pagination). Maximum value is 10,000. To paginate beyond 10,000 results, use search_after instead."
},
"limit": {
"type": "integer",
"description": "Number of companies to return (default: 10, max: 100)"
},
"search_after": {
"type": "string",
"description": "Cursor-based pagination. Pass the search_after value from the previous response to get the next page. Works at any point in the result set, but is required to access results beyond the 10,000 offset limit."
},
"names": {
"type": "array",
"description": "Filter by company names. Use exact_match for precise company name matching.",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The string value to filter by"
},
"exclude": {
"type": "boolean",
"description": "If true, excludes results matching this value. If false or omitted (default), includes only matching results."
},
"exact_match": {
"type": "boolean",
"description": "When true, the value must match exactly as stored (case-insensitive), with no tolerance for variations. When false (default), the API tolerates minor differences such as missing words, extra words, or slight reordering. Matching is never case-sensitive."
}
},
"additionalProperties": false
}
},
"domains": {
"type": "array",
"description": "Filter by company domains (e.g., 'google.com', 'microsoft.com'). Exact match recommended.",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The string value to filter by"
},
"exclude": {
"type": "boolean",
"description": "If true, excludes results matching this value. If false or omitted (default), includes only matching results."
},
"exact_match": {
"type": "boolean",
"description": "When true, the value must match exactly as stored (case-insensitive), with no tolerance for variations. When false (default), the API tolerates minor differences such as missing words, extra words, or slight reordering. Matching is never case-sensitive."
}
},
"additionalProperties": false
}
},
"linkedin_urls": {
"type": "array",
"description": "Filter by LinkedIn URLs.",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The string value to filter by"
},
"exclude": {
"type": "boolean",
"description": "If true, excludes results matching this value. If false or omitted (default), includes only matching results."
},
"exact_match": {
"type": "boolean",
"description": "When true, the value must match exactly as stored (case-insensitive), with no tolerance for variations. When false (default), the API tolerates minor differences such as missing words, extra words, or slight reordering. Matching is never case-sensitive."
}
},
"additionalProperties": false
}
},
"keywords": {
"type": "array",
"description": "Filter by description of company",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The string value to filter by"
},
"exclude": {
"type": "boolean",
"description": "If true, excludes results matching this value. If false or omitted (default), includes only matching results."
},
"exact_match": {
"type": "boolean",
"description": "When true, the value must match exactly as stored (case-insensitive), with no tolerance for variations. When false (default), the API tolerates minor differences such as missing words, extra words, or slight reordering. Matching is never case-sensitive."
}
},
"additionalProperties": false
}
},
"specialties": {
"type": "array",
"description": "Filter by specialties of company",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The string value to filter by"
},
"exclude": {
"type": "boolean",
"description": "If true, excludes results matching this value. If false or omitted (default), includes only matching results."
},
"exact_match": {
"type": "boolean",
"description": "When true, the value must match exactly as stored (case-insensitive), with no tolerance for variations. When false (default), the API tolerates minor differences such as missing words, extra words, or slight reordering. Matching is never case-sensitive."
}
},
"additionalProperties": false
}
},
"industries": {
"type": "array",
"description": "Filter by company industries (e.g., 'Software Development', 'Computer Hardware Manufacturing', 'Housing and Community Development', 'Warehousing', 'Financial Services'). See [Industries](/api/v2/general/enums#company-industry) for the full list.",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The string value to filter by"
},
"exclude": {
"type": "boolean",
"description": "If true, excludes results matching this value. If false or omitted (default), includes only matching results."
},
"exact_match": {
"type": "boolean",
"description": "When true, the value must match exactly as stored (case-insensitive), with no tolerance for variations. When false (default), the API tolerates minor differences such as missing words, extra words, or slight reordering. Matching is never case-sensitive."
}
},
"additionalProperties": false
}
},
"types": {
"type": "array",
"description": "Filter by company types (e.g., 'Public Company', 'Privately Held', 'Nonprofit', 'Self-Employed', 'Partnership', 'Educational', 'Government Agency'). See [Company Types](/api/v2/general/enums#company-type) for the full list.",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The string value to filter by"
},
"exclude": {
"type": "boolean",
"description": "If true, excludes results matching this value. If false or omitted (default), includes only matching results."
},
"exact_match": {
"type": "boolean",
"description": "When true, the value must match exactly as stored (case-insensitive), with no tolerance for variations. When false (default), the API tolerates minor differences such as missing words, extra words, or slight reordering. Matching is never case-sensitive."
}
},
"additionalProperties": false
}
},
"headquarters_locations": {
"type": "array",
"description": "Filter by headquarters locations (city names, regions, or countries)",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The string value to filter by"
},
"exclude": {
"type": "boolean",
"description": "If true, excludes results matching this value. If false or omitted (default), includes only matching results."
},
"exact_match": {
"type": "boolean",
"description": "When true, the value must match exactly as stored (case-insensitive), with no tolerance for variations. When false (default), the API tolerates minor differences such as missing words, extra words, or slight reordering. Matching is never case-sensitive."
}
},
"additionalProperties": false
}
},
"founded_years": {
"type": "array",
"description": "Filter by founding years. Useful for targeting startups (recent years) or established companies.",
"items": {
"type": "object",
"properties": {
"min": {
"type": "integer",
"description": "Minimum founding year (inclusive)"
},
"max": {
"type": "integer",
"description": "Maximum founding year (inclusive)"
},
"exclude": {
"type": "boolean",
"description": "If true, excludes companies founded in this range"
}
},
"additionalProperties": false
}
},
"headcounts": {
"type": "array",
"description": "Filter by company headcounts (number of employees). Use ranges to target specific company sizes (e.g., startups: 1-50, mid-size: 50-500, enterprise: 1000+).",
"items": {
"type": "object",
"properties": {
"min": {
"type": "integer",
"description": "Minimum number of employees (inclusive)"
},
"max": {
"type": "integer",
"description": "Maximum number of employees (inclusive)"
},
"exclude": {
"type": "boolean",
"description": "If true, excludes companies in this range"
}
},
"additionalProperties": false
}
},
"company_ids": {
"type": "array",
"description": "Filter by specific company IDs",
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"description": "The string value to filter by"
},
"exclude": {
"type": "boolean",
"description": "If true, excludes results matching this value. If false or omitted (default), includes only matching results."
},
"exact_match": {
"type": "boolean",
"description": "When true, the value must match exactly as stored (case-insensitive), with no tolerance for variations. When false (default), the API tolerates minor differences such as missing words, extra words, or slight reordering. Matching is never case-sensitive."
}
},
"additionalProperties": false
}
}
},
"required": [],
"additionalProperties": false
}
```
## Output Schema
| Name | Type | Required | Default | Description |
| ------------- | -------- | -------- | ------- | ---------------------------------------------- |
| `result.data` | `object` | Yes | | Provider response payload. |
| `result.meta` | `object` | No | | Additional response metadata (status, paging). |
Show raw output schema
### Output JSON Schema
```json theme={null}
{
"type": "object",
"description": "Standard tool result payload.",
"properties": {
"data": {
"type": "object",
"description": "Provider response payload.",
"properties": {
"companies": {
"type": "array",
"description": "Array of companies matching the search criteria. Returns empty array if no results found.",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique company identifier"
},
"name": {
"type": "string",
"description": "Company name"
},
"domain": {
"type": "string",
"description": "Company domain"
},
"description": {
"type": "string",
"description": "Company description"
},
"year_founded": {
"type": "integer",
"description": "Year the company was founded. Returns 0 when unknown."
},
"headcount": {
"type": "integer",
"description": "Exact number of employees. May return 0 even when headcount_range is available."
},
"headcount_range": {
"type": "string",
"description": "Employee count range (e.g., '1-10', '11-50', '51-200', '201-500', '501-1000', '1001-5000', '5001-10000', '10001+')"
},
"company_type": {
"type": "string",
"description": "Type of company (e.g., 'Public Company', 'Privately Held', 'Nonprofit', 'Self-Employed', 'Partnership', 'Educational', 'Government Agency')"
},
"locations": {
"type": "object",
"description": "Company location information",
"properties": {
"headquarters": {
"type": "object",
"description": "Main headquarters address with structured location fields. Can be an empty object when no headquarters data is available.",
"properties": {
"line1": {
"type": "string",
"description": "Address line 1 (street address)"
},
"line2": {
"type": "string",
"description": "Address line 2 (full location string including city, region, postal code, and country code)"
},
"city": {
"type": "string",
"description": "City name"
},
"region": {
"type": "string",
"description": "State or region"
},
"country": {
"type": "string",
"description": "Country name"
},
"country_code": {
"type": "string",
"description": "ISO country code"
}
},
"additionalProperties": false
},
"offices": {
"type": [
"array",
"null"
],
"description": "Additional office locations. Only contains raw address lines (line1, line2) without structured city/region/country fields. Can be null or an empty array.",
"items": {
"type": "object",
"description": "Office address. Unlike headquarters, office addresses only contain raw address lines without parsed location fields.",
"properties": {
"line1": {
"type": "string",
"description": "Street address"
},
"line2": {
"type": "string",
"description": "Full location string (city, region, postal code, country code)"
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"social_profiles": {
"type": "object",
"description": "Company's social media profiles",
"properties": {
"linkedin": {
"type": "object",
"description": "LinkedIn profile information",
"properties": {
"url": {
"type": "string",
"description": "Full LinkedIn profile URL"
},
"handle": {
"type": "string",
"description": "LinkedIn profile handle/username"
},
"connection_count": {
"type": "integer",
"description": "Number of LinkedIn followers/connections"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"specialties": {
"type": "array",
"description": "Specialties associated with the company",
"items": {
"type": "string"
}
},
"industry": {
"type": "object",
"description": "Company industry information",
"properties": {
"main_industry": {
"type": "string",
"description": "Primary industry category (e.g., 'Software Development', 'Computer Hardware Manufacturing', 'Financial Services', 'Healthcare', 'Retail')"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"metadata": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of results matching the search criteria"
},
"offset": {
"type": "integer",
"description": "Number of results skipped (for pagination)"
},
"search_after": {
"type": "string",
"description": "The cursor value returned by the previous page. Use this to paginate through the results."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"meta": {
"type": "object",
"description": "Additional response metadata (status, paging).",
"additionalProperties": true
}
},
"required": [
"data"
],
"additionalProperties": false
}
```
## Advanced: Direct CLI
Use direct execution for single payload debugging.
```bash theme={null}
deepline tools execute fullenrich_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: `provider_usage` (provider usage).
* Estimated Deepline credits: `0.21` per pricing unit.
* Billing mode: `post_deduct`.