PredictLeads: Discover Companies

Returns a list of companies filtered by their location and size, ordered by last updated date.

Tool ID: predictleads_discover_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.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'predictleads_discover_companies',
  {
    "location": "example",
    "sizes": [
      "1"
    ]
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute predictleads_discover_companies --input '{
  "location": "example",
  "sizes": [
    "1"
  ]
}' --json

Example response

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

Input reference

Returns a list of companies filtered by their location and size, ordered by last updated date. Note: This endpoint returns an estimated count of all results.

Name	Type	Required	Default	Details
`payload.location`	`string`	Yes	—	The response will include only companies located in the given country name or state name/abbreviation.
`payload.sizes`	`array`	Yes	—	An array of one or more valid company sizes.
`payload.page`	`integer`	No	`1`	Page number of shown items. NOTE: If the parameter is not provided, the meta property `count` will be omitted from response for performance reasons. Minimum: 1.
`payload.limit`	`integer`	No	`30`	Limit the number of shown items per page. Maximum: 1000.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Companies Dataset includes data such as Company Name, Meta Title, Meta Description, Structured Location Data, Ticker, Parent Company, Language and other basic company information.
`result.data.data`	`array`	Yes	—	—
`result.data.data[].id`	`string`	Yes	—	ID of the `CompanyLite` object. Format: `uuid`.
`result.data.data[].type`	`"company"`	Yes	—	Type of the `CompanyLite` object.
`result.data.data[].attributes`	`object`	Yes	—	Attributes of the `CompanyLite` object.
`result.data.data[].attributes.domain`	`string`	Yes	—	Company domain name.
`result.data.data[].attributes.company_name`	`string \| null`	Yes	—	Company name if available.
`result.data.data[].attributes.ticker`	`string \| null`	Yes	—	Company stock symbol (ticker) if available.
`result.data.data[].attributes.friendly_company_name`	`string`	Yes	—	Company friendly name.
`result.data.data[].attributes.meta_title`	`string`	Yes	—	Company website’s meta title.
`result.data.data[].attributes.meta_description`	`string`	Yes	—	Company website’s meta description.
`result.data.data[].attributes.description`	`string \| null`	Yes	—	Translated and summarized description.
`result.data.data[].attributes.description_short`	`string \| null`	Yes	—	Short version of the translated and summarized description.
`result.data.data[].attributes.language`	`string`	Yes	—	`Company` website’s language.
`result.data.data[].attributes.location`	`string \| null`	Yes	—	`Company` location. NOTE: It is built from the `location_data` attributes if present.
`result.data.data[].attributes.location_data`	`array`	Yes	—	NOTE: Currently contains at most one object.
`result.data.data[].attributes.location_data[].city`	`string \| null`	Yes	—	City of the location.
`result.data.data[].attributes.location_data[].state`	`string \| null`	Yes	—	State of the location.
`result.data.data[].attributes.location_data[].zip_code`	`string \| null`	Yes	—	ZIP code of the location.
`result.data.data[].attributes.location_data[].country`	`string \| null`	Yes	—	Country of the location.
`result.data.data[].attributes.location_data[].region`	`string \| null`	Yes	—	Region of the location.
`result.data.data[].attributes.location_data[].continent`	`string \| null`	Yes	—	Continent of the location.
`result.data.data[].attributes.location_data[].fuzzy_match`	`boolean \| null`	Yes	—	`true` indicates that location data may not have been extracted accurately. `false` indicates that location data has been extracted correctly.
`result.data.data[].attributes.last_extraction_states`	`array`	No	—	—
`result.data.data[].attributes.last_extraction_states[].attributes`	`object`	Yes	—	Attributes of the `LastExtractionStates` object.
`result.data.data[].attributes.last_extraction_states[].attributes.status`	`string`	Yes	—	Extraction status
`result.data.data[].attributes.last_extraction_states[].attributes.status_code`	`integer`	Yes	—	HTTP response status code
`result.data.data[].attributes.last_extraction_states[].attributes.processed_at`	`string`	Yes	—	Date & time (ISO 8601) of when the `LastExtractionStates` was last processed. Format: `date-time`.
`result.data.data[].relationships`	`object`	Yes	—	The data contains references to related objects listed in the `included` property.
`result.data.data[].relationships.redirects_to`	`object`	Yes	—	The data contains a reference to related `CompanyLite` object listed in the `included` property.
`result.data.data[].relationships.redirects_to.data`	`object \| null`	Yes	—	—
`result.data.data[].relationships.redirects_to.data.id`	`string`	Yes	—	ID of the included `CompanyLite` object. Format: `uuid`.
`result.data.data[].relationships.redirects_to.data.type`	`"company"`	Yes	—	Type of the included `CompanyLite` object.
`result.data.data[].relationships.redirects_to.meta`	`object`	Yes	—	Meta information about the redirect.
`result.data.data[].relationships.redirects_to.meta.reason`	`"acquisition_merger" \| "locality" \| "rebranding"`	Yes	—	Reason of the redirect. Allowed: `acquisition_merger`, `locality`, `rebranding`.
`result.data.data[].relationships.parent_company`	`object`	Yes	—	The data contains a reference to related `CompanyLite` object listed in the `included` property.
`result.data.data[].relationships.parent_company.data`	`object \| null`	Yes	—	—
`result.data.data[].relationships.parent_company.data.id`	`string`	Yes	—	ID of the included `CompanyLite` object. Format: `uuid`.
`result.data.data[].relationships.parent_company.data.type`	`"company"`	Yes	—	Type of the included `CompanyLite` object.
`result.data.data[].relationships.subsidiary_companies`	`object`	Yes	—	The data contains references to related `CompanyLite` objects listed in the `included` property.
`result.data.data[].relationships.subsidiary_companies.data`	`array`	Yes	—	—
`result.data.data[].relationships.subsidiary_companies.data[].id`	`string`	Yes	—	ID of the included `CompanyLite` object. Format: `uuid`.
`result.data.data[].relationships.subsidiary_companies.data[].type`	`"company"`	Yes	—	Type of the included `CompanyLite` object.
`result.data.data[].relationships.similar_companies`	`object`	Yes	—	The data contains references to related `CompanyLite` objects listed in the `included` property.
`result.data.data[].relationships.similar_companies.data`	`array`	Yes	—	—
`result.data.data[].relationships.similar_companies.data[].id`	`string`	Yes	—	ID of the included `CompanyLite` object. Format: `uuid`.
`result.data.data[].relationships.similar_companies.data[].type`	`"company"`	Yes	—	Type of the included `CompanyLite` object.
`result.data.included`	`array`	Yes	—	Contains objects referenced in property `relationships`.
`result.data.included[].id`	`string`	Yes	—	ID of the `CompanyLite` object. Format: `uuid`.
`result.data.included[].type`	`"company"`	Yes	—	Type of the `CompanyLite` object.

The table shows the first 50 fields. Expand the raw schema below for every field.

This output schema is too large for an inline display. Read the complete live contract with deepline describe predictleads_discover_companies --json.

Deepline cost

Pricing model: per_result (per result).
Estimated Deepline credits: 0.56 per pricing unit.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation