> ## 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.
# ZoomInfo: Action Doc
> Search Companies. ZoomInfo Search Companies reference includes SDK V2 and CLI requests, input constraints, response fields, and Deepline cost.
Search Companies.
Tool ID: `zoominfo_search_companies`
## Run this action
Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.
```ts theme={null}
import { Deepline } from 'deepline';
const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
'zoominfo_search_companies',
{
"data": {
"type": "CompanySearch",
"attributes": {
"marketingDepartmentBudgetMin": 123,
"marketingDepartmentBudgetMax": 123,
"financeDepartmentBudgetMin": 123
}
}
},
);
console.log(result.toolResponse.raw);
```
### CLI
```bash theme={null}
deepline tools execute zoominfo_search_companies --input '{
"data": {
"type": "CompanySearch",
"attributes": {
"marketingDepartmentBudgetMin": 123,
"marketingDepartmentBudgetMax": 123,
"financeDepartmentBudgetMin": 123
}
}
}' --json
```
## Example response
The SDK exposes this shape at `result.toolResponse.raw`. Values below are representative.
```json theme={null}
{
"data": {
"data": [
{
"id": "id_123",
"type": "Company",
"attributes": {
"name": "Example",
"city": "San Francisco",
"state": "California"
}
}
]
}
}
```
Use `deepline tools get zoominfo_search_companies --json` for the latest machine-readable contract.
## Input reference
Company search request.
| Name | Type | Required | Default | Details |
| -------------- | -------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `payload.page` | `object` | No | — | The page of results that you want to retrieve. If not provided, the first page of results will be returned. Use in connection with `page[size]` to handle large result sets. Example: `page[number]=2&page[size]=25` will return the second page of result (results 26-50 based on the `sort` value). |
| `payload.sort` | `string` | No | — | Sort results by the specified output field. Valid values are name, employeeCount, and revenue. Add minus sign ('-') for descending order. The default sort if not provided is to sort the results by revenue in descending order `-revenue` Examples: - `name` will sort results by company name in ascending alphabetical order. - `-employeeCount` will sort results in descending order (from company with the most number of employees to the company with the least number of employees) |
| `payload.data` | `object` | Yes | — | Company search request resource. |
This input schema is too large to embed without slowing the page. Get the complete live contract with `deepline tools get zoominfo_search_companies --json`.
## Output reference
Standard tool result payload.
| Name | Type | Required | Default | Details |
| ---------------------------------------------------------------- | --------- | -------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `result.data` | `object` | Yes | — | A list of companies that match the criteria specified in the request |
| `result.data.data` | `array` | Yes | — | The primary data of the document |
| `result.data.data[].id` | `string` | Yes | — | The unique identifier for the resource |
| `result.data.data[].type` | `string` | Yes | `"Company"` | The type of the resource Pattern: `Company`. |
| `result.data.data[].attributes` | `object` | Yes | — | Response attributes for company search. |
| `result.data.data[].attributes.name` | `string` | No | — | Company Name. |
| `result.data.data[].attributes.city` | `string` | No | — | City of the company's primary address. |
| `result.data.data[].attributes.state` | `string` | No | — | State or province of the company's primary address. |
| `result.data.data[].attributes.country` | `string` | No | — | Country of the company's primary address. |
| `result.data.data[].attributes.revenue` | `string` | No | — | Approximate yearly revenue for the company in 1000's. For example, a 100M company is expressed as 100000. |
| `result.data.data[].attributes.employeeCount` | `string` | No | — | Approximate number of people employed by the company. |
| `result.data.data[].attributes.website` | `string` | No | — | Company website URL. |
| `result.data.data[].attributes.logo` | `string` | No | — | The URL which can be used to retrieve the logo for the company. |
| `result.data.data[].attributes.managementStatus` | `object` | No | — | Management status of the record. |
| `result.data.data[].attributes.managementStatus.underManagement` | `boolean` | No | — | Indicates whether record is under management within the contract period. |
| `result.data.data[].attributes.managementStatus.purchaseDate` | `string` | No | — | Indicates when record was purchased if it is under management. Format: `date-time`. |
| `result.data.meta` | `object` | No | — | Metadata including paging information and the total number of records in the result set |
| `result.data.meta.totalResults` | `integer` | Yes | — | The total number of results based on the specified filters Format: `uint32`. |
| `result.data.meta.page` | `object` | Yes | — | Meta information related to the current page and total number of pages |
| `result.data.meta.page.total` | `integer` | Yes | — | The total number of pages within the current result set Format: `uint32`. |
| `result.data.meta.page.number` | `integer` | Yes | — | The current page number of the results Format: `uint32`. |
| `result.data.links` | `object` | No | — | Helpful links for fetching different pages of data from the current result set. When using these links, please provide the exact same request body between requests |
| `result.data.links.first` | `string` | No | — | A link to the first page of data Format: `uri`. |
| `result.data.links.last` | `string` | No | — | A link to the last page of data Format: `uri`. |
| `result.data.links.prev` | `string` | No | — | A link to the previous page of data Format: `uri`. |
| `result.data.links.next` | `string` | No | — | A link to the next page of data Format: `uri`. |
| `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": "A list of companies that match the criteria specified in the request",
"properties": {
"data": {
"type": "array",
"description": "The primary data of the document",
"items": {
"type": "object",
"description": "ZoomInfo Company",
"properties": {
"id": {
"type": "string",
"description": "The unique identifier for the resource"
},
"type": {
"type": "string",
"description": "The type of the resource",
"default": "Company",
"pattern": "Company"
},
"attributes": {
"type": "object",
"description": "Response attributes for company search.",
"properties": {
"name": {
"type": "string",
"description": "Company Name."
},
"city": {
"type": "string",
"description": "City of the company's primary address."
},
"state": {
"type": "string",
"description": "State or province of the company's primary address."
},
"country": {
"type": "string",
"description": "Country of the company's primary address."
},
"revenue": {
"type": "string",
"description": "Approximate yearly revenue for the company in 1000's. For example, a 100M company is expressed as 100000."
},
"employeeCount": {
"type": "string",
"description": "Approximate number of people employed by the company."
},
"website": {
"type": "string",
"description": "Company website URL."
},
"logo": {
"type": "string",
"description": "The URL which can be used to retrieve the logo for the company."
},
"managementStatus": {
"type": "object",
"description": "Management status of the record.",
"properties": {
"underManagement": {
"type": "boolean",
"description": "Indicates whether record is under management within the contract period."
},
"purchaseDate": {
"type": "string",
"description": "Indicates when record was purchased if it is under management.",
"format": "date-time"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"required": [
"id",
"type",
"attributes"
],
"additionalProperties": false
}
},
"meta": {
"type": "object",
"description": "Metadata including paging information and the total number of records in the result set",
"properties": {
"totalResults": {
"type": "integer",
"description": "The total number of results based on the specified filters",
"format": "uint32"
},
"page": {
"type": "object",
"description": "Meta information related to the current page and total number of pages",
"properties": {
"total": {
"type": "integer",
"description": "The total number of pages within the current result set",
"format": "uint32"
},
"number": {
"type": "integer",
"description": "The current page number of the results",
"format": "uint32"
}
},
"required": [
"total",
"number"
],
"additionalProperties": false
}
},
"required": [
"totalResults",
"page"
],
"additionalProperties": false
},
"links": {
"type": "object",
"description": "Helpful links for fetching different pages of data from the current result set. When using these links, please provide the exact same request body between requests",
"properties": {
"first": {
"type": "string",
"description": "A link to the first page of data",
"format": "uri"
},
"last": {
"type": "string",
"description": "A link to the last page of data",
"format": "uri"
},
"prev": {
"type": "string",
"description": "A link to the previous page of data",
"format": "uri"
},
"next": {
"type": "string",
"description": "A link to the next page of data",
"format": "uri"
}
},
"additionalProperties": false
}
},
"required": [
"data"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"description": "Additional response metadata (status, paging).",
"additionalProperties": true
}
},
"required": [
"data"
],
"additionalProperties": false
}
```
## Deepline cost
* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.
## Related documentation
* [ZoomInfo provider guide](/docs/providers/zoominfo/guide)
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)