---
canonical_url: "https://docs.composio.dev/toolkits/harvestapi"
markdown_url: "https://docs.composio.dev/toolkits/harvestapi.md"
product: "platform"
version: null
last_updated: null
---

# HarvestAPI

HarvestAPI provides recruiting and lead intelligence through LinkedIn people and company search, profile enrichment, and company enrichment APIs.

- **Category:** hr talent & recruitment
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 32
- **Triggers:** 0
- **Slug:** `HARVESTAPI`
- **Version:** 00000000_00

## Tools

### Get LinkedIn Account Insights

**Slug:** `HARVESTAPI_GET_ACCOUNT_INSIGHTS`

Get broad LinkedIn company intelligence including company and revenue data, AI-generated sourced summaries, competitors, key people, headcount, hiring, news, suggested contacts, and alerts. Generated summaries are not verified facts. This provider-scraping read can return identifiable executives, leads, posts, and relationship signals; billing, credit use, and account-tier behavior are unverified.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | Yes | Company URL, universal name, or ID; an ID skips provider lookup. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get LinkedIn Ad

**Slug:** `HARVESTAPI_GET_AD`

Get detailed creative, advertiser, impression, and targeting data for one LinkedIn ad. Callers can provide an ID or URL. This is a provider-scraping read; billing, credit use, and account-tier behavior are not verified.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | Optional LinkedIn ad URL; callers can provide this or an ad ID. |
| `ad_id` | string | No | Optional LinkedIn ad ID; callers can provide this or an ad URL. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get LinkedIn Comment Reactions

**Slug:** `HARVESTAPI_GET_COMMENT_REACTIONS`

Get one page of reactions to a LinkedIn comment. This provider-scraping read returns reactors' profile identity and position; billing, credit use, and account-tier behavior are not verified.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | LinkedIn comment URL whose reactions should be returned. |
| `next_cursor` | integer | No | Next page number returned by the previous call. Omit for page 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get LinkedIn Company

**Slug:** `HARVESTAPI_GET_COMPANY`

Enrich one LinkedIn company by company URL, universal name, or company ID. This is a provider-scraping read; billing and account-tier behavior are not verified.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | Yes | LinkedIn company URL, universal name, or company ID to enrich. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get LinkedIn Company People Stats

**Slug:** `HARVESTAPI_GET_COMPANY_PEOPLE_STATS`

Return aggregate LinkedIn employee distributions for a company across location, school, function, skills, services, and fields of study. This is a provider-scraping read; billing, credit use, and account-tier behavior are unverified.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | Yes | Company URL, universal name, or ID; an ID skips provider lookup. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get LinkedIn Company Posts

**Slug:** `HARVESTAPI_GET_COMPANY_POSTS`

Get one page of posts from a LinkedIn company. Date post-filtering can make provider pagination metadata inaccurate. This provider-scraping read may consume credits; billing and account-tier behavior are not verified.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company` | string | No | Optional company URL, universal name, or ID filter. |
| `next_cursor` | object | No | Page and token returned by the previous call. |
| `posted_limit` | string ("24h" | "week" | "month") | No | Provider-side age filter; returned pagination may be inaccurate. |
| `scrape_posted_limit` | string ("1h" | "24h" | "week" | "month" | "3months" | "6months" | "year") | No | HarvestAPI post-filter maximum age. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get LinkedIn Event

**Slug:** `HARVESTAPI_GET_EVENT`

Get one LinkedIn event by URL or ID, including timing, venue, organizer, speakers, and announcement post. This provider-scraping read may expose personal names, profile URLs, photos, and headlines and may consume HarvestAPI credits; billing and account-tier behavior are unverified.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | Optional LinkedIn event URL; provide this or event_id. |
| `event_id` | string | No | Optional LinkedIn event ID; provide this or url. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get LinkedIn Group

**Slug:** `HARVESTAPI_GET_GROUP`

Get complete details for one LinkedIn group. Callers can provide a URL or group ID. Results may identify group administrators. This is a provider-scraping read; billing, credit use, and account-tier behavior are not verified.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | Optional LinkedIn group URL; callers can provide this or a group ID. |
| `group_id` | string | No | Optional LinkedIn group ID; callers can provide this or a group URL. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get LinkedIn Job

**Slug:** `HARVESTAPI_GET_JOB`

Get complete details for one LinkedIn job. Callers can provide a job ID or URL. This is a provider-scraping read; billing, credit use, and account-tier behavior are not verified.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | No | Optional LinkedIn job URL; callers can provide this or a job ID. |
| `job_id` | string | No | Optional LinkedIn job ID; callers can provide this or a job URL. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get My API User

**Slug:** `HARVESTAPI_GET_MY_API_USER`

Return details for the HarvestAPI user associated with the connected API key. Use this to identify the connected account without consuming scraping credits. The response may contain account-identifying information because the provider does not document its fields.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get My Private Account Pools

**Slug:** `HARVESTAPI_GET_MY_PRIVATE_ACCOUNT_POOLS`

Return private LinkedIn account-pool details associated with the connected HarvestAPI API user. This platform account-metadata read does not invoke a LinkedIn scraping endpoint or consume scraping credits. The undocumented response may contain sensitive pool and backing-account identifiers.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get LinkedIn Post

**Slug:** `HARVESTAPI_GET_POST`

Get one LinkedIn post by URL. This provider-scraping read may consume HarvestAPI credits and returns authored content and author identity; billing and account-tier behavior are not verified.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | LinkedIn post URL. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get LinkedIn Post Comment Replies

**Slug:** `HARVESTAPI_GET_POST_COMMENT_REPLIES`

Get one page of replies to a LinkedIn comment. This provider-scraping read returns repliers' identities, profile details, and authored text. Billing, credit use, and account-tier behavior are not verified.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Direct LinkedIn URL of the comment whose replies to return. |
| `next_cursor` | string | No | Opaque continuation token returned by the preceding call. Omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get LinkedIn Post Comments

**Slug:** `HARVESTAPI_GET_POST_COMMENTS`

Get one page of comments for a LinkedIn post. This provider-scraping read returns commenters' identities, profile details, and authored text. Billing, credit use, and account-tier behavior are not verified.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `post` | string | Yes | LinkedIn post URL whose comments should be returned. |
| `sort_by` | string ("relevance" | "date") | No | Comment ordering. Relevance continuations after page 1 require a pagination token. |
| `next_cursor` | object | No | Page and optional token returned by the preceding call. Omit for page 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get LinkedIn Post Reactions

**Slug:** `HARVESTAPI_GET_POST_REACTIONS`

Get one page of reactions to a LinkedIn post. This provider-scraping read returns reactors' profile identity and position; billing, credit use, and account-tier behavior are not verified.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `post` | string | Yes | LinkedIn post URL whose reactions should be returned. |
| `sort_by` | string ("relevance" | "date") | No | Reaction ordering documented by HarvestAPI: relevance or date. |
| `next_cursor` | integer | No | Next page number returned by the previous call. Omit for page 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get LinkedIn Profile

**Slug:** `HARVESTAPI_GET_PROFILE`

Enrich one LinkedIn profile by URL, public identifier, or profile ID. Profile enrichment consumes HarvestAPI credits; main=true uses fewer credits. find_email=true explicitly opts into separately billable email discovery and SMTP validation and may return professional or publicly disclosed personal email addresses, including risky catch-all results.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `main` | boolean | No | Return a reduced main profile (up to 5 experiences, 2 educations, and 2 skills) for fewer credits. Omit or set false for the full profile. |
| `query` | string | Yes | LinkedIn profile URL, public identifier, or profile ID to enrich. |
| `find_email` | boolean | No | Explicitly opt into additional-credit email discovery and SMTP validation. This may return professional or publicly disclosed personal email addresses; catch-all results are risky and discovery is not guaranteed. Omit or set false to disable email discovery. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get LinkedIn Profile by Email

**Slug:** `HARVESTAPI_GET_PROFILE_BY_EMAIL`

Reverse lookup a LinkedIn profile from a work email address. This provider-scraping read exposes personal identity, employment, profile, and supplied email data. It consumes HarvestAPI credits; exact billing and account-tier behavior are unverified. Personal email domains and role addresses may be rejected.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Work email address to reverse lookup. |
| `last_name` | string | No | Known last name; overrides the last name inferred from the email. |
| `first_name` | string | No | Known first name; overrides the first name inferred from the email. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get LinkedIn Profile Comments

**Slug:** `HARVESTAPI_GET_PROFILE_COMMENTS`

Get one page of comments authored by a LinkedIn profile, optionally limited by age. This provider-scraping read exposes a person's authored activity, identity, and profile details. Billing, credit use, and account-tier behavior are not verified.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `profile` | string | No | Optional LinkedIn profile URL, public identifier, or profile ID filter. |
| `next_cursor` | object | No | Page and token returned by the preceding call. Omit for page 1. |
| `posted_limit` | string ("24h" | "month" | "week") | No | Maximum age of comments to return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get LinkedIn Profile Posts

**Slug:** `HARVESTAPI_GET_PROFILE_POSTS`

Use this dedicated profile feed to retrieve a profile's complete authored-post history one page at a time; unlike SEARCH_POSTS, it is intended for complete profile post retrieval. Date post-filtering can make provider pagination metadata inaccurate. This provider-scraping read may consume credits and returns a person's authored content and identity; billing and account-tier behavior are not verified.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `profile` | string | No | Optional profile URL, public identifier, or ID filter. |
| `next_cursor` | object | No | Page and token returned by the previous call. |
| `posted_limit` | string ("24h" | "week" | "month") | No | Provider-side age filter; returned pagination may be inaccurate. |
| `scrape_posted_limit` | string ("1h" | "24h" | "week" | "month" | "3months" | "6months" | "year") | No | HarvestAPI post-filter maximum age. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get LinkedIn Profile Reactions

**Slug:** `HARVESTAPI_GET_PROFILE_REACTIONS`

Get one page of reactions made by a LinkedIn profile. This provider-scraping read exposes a person's reaction activity and profile identity; billing, credit use, and account-tier behavior are not verified.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `profile` | string | No | Optional LinkedIn profile URL, public identifier, or profile ID filter. |
| `next_cursor` | object | No | Page and token returned by the previous call. Omit for page 1. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search LinkedIn Accounts

**Slug:** `HARVESTAPI_SEARCH_ACCOUNTS`

Find LinkedIn companies with advanced recruiting and sales filters such as growth, hiring, department headcount, activity, and exclusions, returning one 25-result page. This is a provider-scraping read; billing, credit use, and account-tier behavior are not verified.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `search` | string | No | Fuzzy company search query; supports LinkedIn search operators. |
| `session_id` | string | No | Caller-generated stable session identifier for cross-page consistency; runtime queueing behavior is unverified. |
| `next_cursor` | integer | No | Page cursor returned by the previous call. Omit for page 1; pages are capped at 100 and contain 25 results. |
| `industry_ids` | array | No | LinkedIn industry IDs to include (maximum 70). |
| `fortune_ranks` | array | No | Fortune 500 rank bands to include. |
| `annual_revenue` | string | No | Annual revenue range in millions as min-max with optional currency, for example '1-10;USD'. |
| `company_headcount` | array | No | Documented company employee-count ranges to include. |
| `job_opportunities` | string | No | Set to HIRING_ON_LINKEDIN to include companies hiring on LinkedIn. |
| `account_activities` | array | No | Recent company activity signals to include. |
| `headquarter_geo_ids` | array | No | Headquarters LinkedIn Geo IDs to include (maximum 70). Resolve IDs with SEARCH_GEO_IDS. |
| `number_of_followers` | array | No | Documented LinkedIn follower-count ranges to include. |
| `department_headcount` | string | No | Department headcount as min-max;department, for example '10-100;Engineering'. Accepted departments: Accounting, Administrative, Arts and Design, Business Development, Community and Social Services, Consulting, Education, Engineering, Entrepreneurship, Finance, Healthcare Services, Human Resources, Information Technology, Legal, Marketing, Media and Communication, Military and Protective Services, Operations, Product Management, Program and Project Management, Purchasing, Quality Assurance, Real Estate, Research, Sales, Support. |
| `exclude_industry_ids` | array | No | LinkedIn industry IDs to exclude (maximum 70). |
| `headquarter_locations` | array | No | Headquarters location text values to include (maximum 70). |
| `company_headcount_growth` | string | No | Company headcount growth percentage range as min-max, for example '1-100'. |
| `exclude_company_headcount` | array | No | Documented company employee-count ranges to exclude. |
| `department_headcount_growth` | string | No | Department headcount growth percentage as min-max;department, for example '5-50;Sales'. Accepted departments: Accounting, Administrative, Arts and Design, Business Development, Community and Social Services, Consulting, Education, Engineering, Entrepreneurship, Finance, Healthcare Services, Human Resources, Information Technology, Legal, Marketing, Media and Communication, Military and Protective Services, Operations, Product Management, Program and Project Management, Purchasing, Quality Assurance, Real Estate, Research, Sales, Support. |
| `exclude_headquarter_geo_ids` | array | No | Headquarters LinkedIn Geo IDs to exclude (maximum 70). |
| `exclude_headquarter_locations` | array | No | Headquarters location text values to exclude (maximum 70). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search LinkedIn Ads

**Slug:** `HARVESTAPI_SEARCH_ADS`

Search the LinkedIn Ad Library by a complete search URL or structured keyword, advertiser, country, and date filters, returning one page. This is a provider-scraping read; billing, credit use, and account-tier behavior are not verified.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `keyword` | string | No | Ad keyword. |
| `end_date` | string | No | Optional YYYY-MM-DD end date intended for custom-date-range filtering. |
| `countries` | string | No | Country codes to include, or ALL to search all countries. |
| `search_url` | string | No | Complete LinkedIn Ad Library search URL. |
| `start_date` | string | No | Optional YYYY-MM-DD start date intended for custom-date-range filtering. |
| `date_option` | string ("last-30-days" | "current-month" | "current-year" | "last-year" | "custom-date-range") | No | Optional date filter mode; use custom-date-range with date bounds when desired. |
| `next_cursor` | string | No | Opaque pagination token from the previous response. Pass it unchanged. |
| `account_owner` | string | No | Company or advertiser name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search LinkedIn Companies

**Slug:** `HARVESTAPI_SEARCH_COMPANIES`

Find LinkedIn companies by name keywords, location, size, or industry and return one controllable result page. This is a provider-scraping read; billing and account-tier behavior are not verified.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `geo_id` | string | No | LinkedIn Geo ID; overrides location. Resolve it with SEARCH_GEO_IDS. |
| `search` | string | No | Keywords to match in LinkedIn company names. |
| `location` | string | No | Location text to match. Use geo_id for stable matching when autocomplete is ambiguous. |
| `next_cursor` | integer | No | Page cursor returned by the previous call. Omit for page 1. |
| `industry_ids` | array | No | One or more LinkedIn industry IDs. |
| `company_sizes` | array | No | One or more documented employee-count ranges. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search LinkedIn Events

**Slug:** `HARVESTAPI_SEARCH_EVENTS`

Search LinkedIn events by keywords and return one controllable page. Results may expose organizer names and public event details and this provider-scraping read may consume HarvestAPI credits; billing and account-tier behavior are unverified.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `search` | string | Yes | Required event-search keywords, up to 300 characters. |
| `next_cursor` | integer | No | Page number returned by the previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search LinkedIn Geo IDs

**Slug:** `HARVESTAPI_SEARCH_GEO_IDS`

Resolve location text to LinkedIn Geo IDs for precise people and company search filters. This is a provider-scraping read; billing and account-tier behavior are not verified.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `search` | string | Yes | Location text to resolve to a LinkedIn Geo ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search LinkedIn Groups

**Slug:** `HARVESTAPI_SEARCH_GROUPS`

Search LinkedIn groups by keyword and return one controllable result page. This is a provider-scraping read; billing, credit use, and account-tier behavior are not verified.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `search` | string | No | Keywords to search for in LinkedIn groups. |
| `next_cursor` | integer | No | Page number returned by the previous call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search LinkedIn Jobs

**Slug:** `HARVESTAPI_SEARCH_JOBS`

Search LinkedIn jobs by title, company, location, work arrangement, employment type, salary, recency, seniority, industry, or function and return one controllable page. This is a provider-scraping read; billing, credit use, and account-tier behavior are not verified.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `geo_id` | string | No | LinkedIn Geo ID; overrides location. Resolve it with SEARCH_GEO_IDS. |
| `salary` | string ("40k+" | "60k+" | "80k+" | "100k+" | "120k+" | "140k+" | "160k+" | "180k+" | "200k+") | No | Documented minimum salary band. |
| `search` | string | No | Job-title search text. |
| `sort_by` | string ("relevance" | "date") | No | Result ordering: relevance or date. |
| `location` | string | No | Location text; overridden when geo_id is supplied. |
| `easy_apply` | boolean | No | True includes and false excludes Easy Apply jobs. |
| `company_ids` | array | No | One or more LinkedIn company IDs. |
| `next_cursor` | integer | No | Page number returned by the previous call; the provider caps pages at 40. |
| `function_ids` | array | No | One or more LinkedIn job-function IDs. |
| `industry_ids` | array | No | One or more LinkedIn industry IDs. |
| `posted_limit` | string ("24h" | "month" | "week") | No | Maximum posting age. |
| `workplace_types` | array | No | One or more workplace arrangements. |
| `employment_types` | array | No | One or more employment types. |
| `experience_levels` | array | No | One or more experience levels. |
| `under_10_applicants` | string | No | Set to 'true' to include only jobs with fewer than 10 applicants. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search LinkedIn Leads

**Slug:** `HARVESTAPI_SEARCH_LEADS`

Search LinkedIn people for recruiting candidates or sales prospects with advanced inclusion and exclusion filters, including a Sales Navigator search URL, and return one controllable result page. This provider-scraping operation returns personal identity, employment, and location data. Billing, credit use, and account-tier behavior are not verified.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `search` | string | No | Fuzzy candidate search query; supports LinkedIn search operators. |
| `geo_ids` | array | No | LinkedIn Geo IDs to include (maximum 70); overrides locations. Resolve IDs with SEARCH_GEO_IDS. |
| `schools` | array | No | School IDs or LinkedIn school URLs to include (maximum 50). |
| `locations` | array | No | Location text values to include (maximum 70); ignored when geo_ids is supplied. |
| `last_names` | array | No | Last names to include (maximum 70). |
| `session_id` | string | No | Caller-generated stable session identifier for cross-page consistency; it may increase queueing latency and does not guarantee the same backend resource. |
| `first_names` | array | No | First names to include (maximum 70). |
| `next_cursor` | integer | No | Page cursor returned by the previous call. Omit for page 1; the provider clamps pages at 100. |
| `function_ids` | array | No | Function IDs: 1 Accounting, 2 Administrative, 3 Arts and Design, 4 Business Development, 5 Community and Social Services, 6 Consulting, 7 Education, 8 Engineering, 9 Entrepreneurship, 10 Finance, 11 Healthcare Services, 12 Human Resources, 13 Information Technology, 14 Legal, 15 Marketing, 16 Media and Communication, 17 Military and Protective Services, 18 Operations, 19 Product Management, 20 Program and Project Management, 21 Purchasing, 22 Quality Assurance, 23 Real Estate, 24 Research, 25 Sales, 26 Customer Success and Support. |
| `industry_ids` | array | No | LinkedIn industry IDs to include (maximum 70). |
| `sales_nav_url` | string | No | LinkedIn Sales Navigator search URL. It overrides every other search filter except pagination. |
| `past_companies` | array | No | Past company IDs or LinkedIn company URLs to include (maximum 50). |
| `exclude_geo_ids` | array | No | LinkedIn Geo IDs to exclude (maximum 70). |
| `exclude_schools` | array | No | School IDs or URLs to exclude (maximum 50). |
| `past_job_titles` | array | No | Past job titles to include (maximum 70). |
| `use_private_pool` | string | No | Set to 'true' only when the connected HarvestAPI account has a documented private resource pool. |
| `company_headcount` | array | No | Company headcount codes: A=self-employed, B=1-10, C=11-50, D=51-200, E=201-500, F=501-1000, G=1001-5000, H=5001-10000, I=10001+. |
| `current_companies` | array | No | Current company IDs or LinkedIn company URLs to include (maximum 50). |
| `exclude_locations` | array | No | Location text values to exclude (maximum 70). |
| `profile_languages` | array | No | Language codes: ar Arabic, en English, es Spanish, pt Portuguese, zh Chinese, fr French, it Italian, ru Russian, de German, nl Dutch, tr Turkish, tl Tagalog, pl Polish, ko Korean, ja Japanese, ms Malay, no Norwegian, da Danish, ro Romanian, sv Swedish, in Bahasa Indonesia, cs Czech. |
| `current_job_titles` | array | No | Current job titles to include (maximum 70). |
| `posted_on_linkedin` | boolean | No | When true, include leads who posted on LinkedIn in the last 30 days. |
| `required_account_id` | string | No | Private-pool account ID to require for this search. Use only for an account provisioned with a private pool; it does not require setting use_private_pool. |
| `seniority_level_ids` | array | No | Seniority IDs: 100=In Training, 110=Entry Level, 120=Senior, 130=Strategic, 200=Entry Level Manager, 210=Experienced Manager, 220=Director, 300=Vice President, 310=CXO, 320=Owner/Partner. |
| `exclude_function_ids` | array | No | Function IDs to exclude (maximum 30): integer strings 1-26 using the same ID-to-function mapping documented on function_ids. |
| `exclude_industry_ids` | array | No | LinkedIn industry IDs to exclude (maximum 70). |
| `recently_changed_jobs` | boolean | No | When true, include leads who changed jobs in the last 90 days. |
| `exclude_past_companies` | array | No | Past company IDs or URLs to exclude (maximum 50). |
| `exclude_past_job_titles` | array | No | Past job titles to exclude (maximum 70). |
| `years_of_experience_ids` | array | No | Years of experience IDs: 1=under 1 year, 2=1-2 years, 3=3-5 years, 4=6-10 years, 5=over 10 years. |
| `exclude_current_companies` | array | No | Current company IDs or URLs to exclude (maximum 50). |
| `exclude_current_job_titles` | array | No | Current job titles to exclude (maximum 70). |
| `exclude_seniority_level_ids` | array | No | Seniority IDs to exclude (maximum 20): 100 In Training, 110 Entry Level, 120 Senior, 130 Strategic, 200 Entry Level Manager, 210 Experienced Manager, 220 Director, 300 Vice President, 310 CXO, 320 Owner/Partner. |
| `years_at_current_company_ids` | array | No | Years at current company IDs: 1=under 1 year, 2=1-2 years, 3=3-5 years, 4=6-10 years, 5=over 10 years. |
| `company_headquarter_locations` | array | No | Company headquarters location text values to include (maximum 70). |
| `exclude_company_headquarter_locations` | array | No | Company headquarters location text values to exclude (maximum 70). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search LinkedIn Posts

**Slug:** `HARVESTAPI_SEARCH_POSTS`

Search LinkedIn posts by keywords, authors, companies, mentions, content type, group, and date controls, returning one page only. Provider date post-filtering can make pagination metadata and has_more inaccurate. Profile and company author filters may return fewer results; use GET_PROFILE_POSTS or GET_COMPANY_POSTS for complete author feeds. This provider-scraping read may consume credits and returns authored content and identities; billing and account-tier behavior are not verified.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group` | string | No | LinkedIn group URL or ID. |
| `search` | string | No | Post keywords. |
| `sort_by` | string ("relevance" | "date") | No | Result ordering. |
| `profiles` | array | No | Author profile URLs, identifiers, or IDs. |
| `companies` | array | No | Author company URLs or IDs. |
| `next_cursor` | object | No | Page and token returned by the previous call. |
| `content_type` | string ("videos" | "images" | "live_videos" | "documents" | "collaborative_articles" | "jobs") | No | Post content type. |
| `posted_limit` | string ("24h" | "week" | "month") | No | LinkedIn-side maximum age. |
| `author_keywords` | string | No | Keywords in author profiles. |
| `authors_companies` | array | No | Companies where post authors work. |
| `mentioning_members` | array | No | Mentioned profile URLs or IDs. |
| `scrape_posted_limit` | string ("1h" | "24h" | "week" | "month" | "3months" | "6months" | "year") | No | HarvestAPI post-filter maximum age. |
| `authors_industry_ids` | array | No | Industries of authors' companies. |
| `mentioning_companies` | array | No | Mentioned company URLs or IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search LinkedIn Profiles

**Slug:** `HARVESTAPI_SEARCH_PROFILES`

Search public LinkedIn profiles by person, employer, school, title, location, industry, or follower relationship and return one result page. Results can be anonymized. This provider-scraping read returns personal identity, employment, location, and profile URL data; billing, credit use, and tier behavior are unverified.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | No | Job-title filter. |
| `geo_id` | string | No | LinkedIn Geo ID; overrides location. |
| `search` | string | No | Profile-name search text. |
| `schools` | array | No | School IDs or URLs. |
| `location` | string | No | Location text; overridden by geo_id. |
| `last_name` | string | No | Last-name filter. |
| `first_name` | string | No | First-name filter. |
| `next_cursor` | integer | No | Page number returned by the previous call. |
| `followers_of` | array | No | Profile URLs or IDs whose followers should match. |
| `industry_ids` | array | No | LinkedIn industry IDs. |
| `past_companies` | array | No | Past company IDs or URLs. |
| `school_keywords` | string | No | Keywords in school names. |
| `company_keywords` | string | No | Keywords in company names. |
| `current_companies` | array | No | Current company IDs or URLs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search LinkedIn Services

**Slug:** `HARVESTAPI_SEARCH_SERVICES`

Search LinkedIn service-provider profiles by service or name keywords and location. This provider-scraping read returns personal identity, position, location, and profile URL data; billing, credit use, and tier behavior are unverified.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `geo_id` | string | No | LinkedIn Geo ID; overrides location. |
| `search` | string | Yes | Required service or profile search text. |
| `location` | string | No | Location text; overridden by geo_id. |
| `next_cursor` | integer | No | Page number returned by the previous call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search LinkedIn Typeahead

**Slug:** `HARVESTAPI_SEARCH_TYPEAHEAD`

Return LinkedIn search-bar suggestions or one page of company, school, or profile suggestions. Typed searches expose up to 100 results per page and may return personal identity and profile data. This is a provider-scraping read that consumes HarvestAPI credits; exact billing and tier behavior are unverified.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page 1-20 for a typed search; must be 1 when type is omitted. |
| `type` | string ("company" | "school" | "profile") | No | Return one entity type only, with 100 suggestions per page. Omit for LinkedIn's mixed one-page search-bar suggestions. |
| `search` | string | Yes | Text typed into LinkedIn's search bar, up to 100 characters. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |
