HarvestAPI: Search Companies

Search LinkedIn companies by name, location, company size, and industry.

Tool ID: harvestapi_search_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(
  'harvestapi_search_companies',
  {
    "search": "software companies hiring engineers",
    "location": "example",
    "geoId": "geo_123"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute harvestapi_search_companies --input '{
  "search": "software companies hiring engineers",
  "location": "example",
  "geoId": "geo_123"
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "elements": [
      {
        "universalName": "Example"
      }
    ],
    "pagination": {
      "totalPages": 123,
      "totalElements": 123,
      "pageNumber": 123
    },
    "status": 1
  }
}

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

Input reference

Retrieve a list of LinkedIn companies matching the specified search criteria.

Name	Type	Required	Default	Details
`payload.search`	`string`	No	—	Keywords to search for in company names.
`payload.location`	`string`	No	—	Filter companies by location.
`payload.geoId`	`string`	No	—	Filter by location as LinkedIn Geo ID. Overrides the location query param. Use the /linkedin/geo-id-search endpoint to find the Geo ID
`payload.companySize`	`string`	No	—	Filter by company size. One value or multiple comma-separated. Supported values: ‘1-10’, ‘11-50’, ‘51-200’, ‘201-500’, ‘501-1000’, ‘1001-5000’, ‘5001-10000’, ‘10001+‘
`payload.industryId`	`string`	No	—	Filter by industry ID. One value or multiple comma-separated industry IDs. Full list of IDs: https://github.com/HarvestAPI/linkedin-industry-codes-v2/blob/main/linkedin_industry_code_v2_all_eng.csv
`payload.page`	`integer`	No	`1`	Page number for pagination.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Provider response payload.
`result.data.elements`	`array`	No	—	—
`result.data.elements[].id`	`string`	No	—	—
`result.data.elements[].name`	`string`	No	—	—
`result.data.elements[].industries`	`string`	No	—	—
`result.data.elements[].location`	`object`	No	—	—
`result.data.elements[].location.linkedinText`	`string`	No	—	—
`result.data.elements[].followers`	`string`	No	—	—
`result.data.elements[].summary`	`string \| null`	No	—	—
`result.data.elements[].logo`	`string \| null`	No	—	—
`result.data.elements[].linkedinUrl`	`string`	No	—	—
`result.data.elements[].universalName`	`string`	Yes	—	—
`result.data.pagination`	`object`	No	—	—
`result.data.pagination.totalPages`	`integer`	No	—	Format: `int32`.
`result.data.pagination.totalElements`	`integer`	No	—	Format: `int32`.
`result.data.pagination.pageNumber`	`integer`	No	—	Format: `int32`.
`result.data.pagination.previousElements`	`integer`	No	—	Format: `int32`.
`result.data.pagination.pageSize`	`integer`	No	—	Format: `int32`.
`result.data.pagination.paginationToken`	`string`	No	—	Format: `nullable`.
`result.data.status`	`string \| integer`	No	—	—
`result.data.error`	`string \| null`	No	—	—
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: provider_usage (provider usage).
Estimated Deepline credits: 0.03 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