div # Data Catalog This page provides a complete reference for the Lusha API, covering the **Data Catalog** (all available fields organized by contact and company data types) and **API Endpoint Structure** (input parameters and output fields for each endpoint). style body, html { margin: 0; padding: 0; width: 100%; height: 100%; } .document-container { display: flex; flex-direction: column; flex: 1; width: 100%; min-width: 100%; justify-content: space-between; margin: 0; padding: 0; } .details-box { background-color: transparent; border: none; margin: 4px 0; flex: 1; width: 100%; } .details-box > details > summary { list-style: none; cursor: pointer; display: flex; align-items: center; gap: 8px; font-weight: bold; padding: 12px; background-color: transparent; border: 1px solid #e0e0e0; border-radius: 8px 8px 0 0; } .details-box > details > summary::-webkit-details-marker { display: none; } .details-box > details > summary::before { content: "▶"; display: inline-block; transition: transform 0.2s; font-size: 12px; } .details-box > details[open] > summary::before { transform: rotate(90deg); } .details-box > details[open] > summary { border-radius: 8px 8px 0 0; border-bottom: 1px solid #e0e0e0; } .details-box > details[open] { background-color: transparent; border: 1px solid #e0e0e0; border-top: none; border-radius: 0 0 8px 8px; padding: 12px; margin: 0; display: flex; flex-direction: column; flex: 1; width: 100%; } .details-box > details > .inner-box { background-color: transparent; border: 1px solid #e0e0e0; border-radius: 4px; padding: 0; margin: 0; display: flex; flex-direction: column; flex: 1; width: 100%; } .details-box > details > .inner-box > details[open] { padding: 16px 20px; display: flex; flex-direction: column; flex: 1; width: 100%; } .details-box > details > .inner-box > details { border-bottom: 1px solid #e0e0e0; margin: 0; background-color: transparent; display: flex; flex-direction: column; flex: 1; width: 100%; } .details-box > details > .inner-box > details:last-child { border-bottom: none; } .details-box > details > .inner-box > details > summary { background-color: transparent; border: none; border-bottom: 1px solid #e0e0e0; padding: 12px; margin: 0; display: flex; align-items: center; gap: 8px; font-weight: normal; border-radius: 0; list-style: none; } .details-box > details > .inner-box > details > summary::-webkit-details-marker { display: none; } .details-box > details > .inner-box > details > summary::before { content: "▶"; display: inline-block; font-size: 12px; transition: transform 0.2s; } .details-box > details > .inner-box > details[open] > summary::before { transform: rotate(90deg); } ## Contact Data All contact data values available in the Lusha API, organized by data category. ### Personal Information | Field Name | Description | Data Type | | --- | --- | --- | | First Name | The contact's first name | String | | Last Name | The contact's last name | String | | Full Name | The concatenated first and last name | String | | LinkedIn | Validated URL for the contact's LinkedIn profile | URL | | X URL | Twitter/X profile URL | String | ### Social & Profile Data | Field Name | Description | Data Type | | --- | --- | --- | | LinkedIn Followers Count | LinkedIn followers count | Integer | | LinkedIn Connections Count | LinkedIn connections count | Integer | | LinkedIn Certifications | Professional certifications from LinkedIn | Array | | LinkedIn Courses | Courses listed on LinkedIn | Array | | LinkedIn Awards | Honors and awards from LinkedIn | Array | | LinkedIn Skills | Skills listed on LinkedIn profile | Array [String] | ### Contact Information | Field Name | Description | Data Type | | --- | --- | --- | | Email | The verified email address | String | | Email Type | Classification (e.g., work, personal) | String | | Email Update Date | The date this specific email was last verified | Date | | Email Confidence | Confidence score for deliverability (e.g., A+) | String | | Phone Number | Phone number in international format | String | | Phone Type | Classification (e.g., mobile, direct, office) | String | | Do Not Call | Boolean flag for DNC (Do Not Call) registry status | Boolean | | Phone Update Date | The date this specific phone was last verified | Date | ### Location Information | Field Name | Description | Data Type | | --- | --- | --- | | Continent | Continent name of the contact | String | | Country | Country name of the contact | String | | Country ISO2 | Two-letter ISO country code | String | | City | City name | String | | EU Contact | Boolean indicating if the contact is in the European Union | Boolean | | Coordinates | Array [Longitude, Latitude] for the contact | Array [Float] | ### Professional Data | Field Name | Description | Data Type | | --- | --- | --- | | Job Title | The full, raw job title string | String | | Seniority | Standardized seniority (e.g., Vice President, Manager) | String | | Departments | Array of functional business units (e.g., General Management) | Array | | Job Start Date | The date the contact started their current role | Date | ### Career History | Field Name | Description | Data Type | | --- | --- | --- | | Previous Company | Name of the previous employer organization | String | | Previous Domain | The web domain of the previous employer | String | | Previous Title | The title held at the previous company | String | | Previous Seniority | The seniority level of the previous role | String | ### Contact Signals | Signal Type | Description | | --- | --- | | Company Change Signal | Triggered when a contact moves to a new organization | | Promotion Signal | Triggered when a contact is promoted within their organization | ## Company Data All company data values available in the Lusha API, organized by data category. ### Firmographics | Field Name | Description | Data Type | | --- | --- | --- | | Name | Legal or common trade name of the company | String | | FQDN | Fully Qualified Domain Name | String | | Founded | The year the organization was established | String | | Description | Comprehensive textual bio or mission statement | String | | Logo URL | CDN link to the company's brand logo image | URL | | Company Size | Array [Min, Max] of employee count | Array [Integer] | | Revenue Range | Array [Min, Max] of annual revenue | Array [Integer] | | Homepage Domain | Root domain for the corporate website | String | | Email Domain | Primary domain used for corporate email addresses | String | | Alternative Name | Normalized alternative company name | String | | Company Type | Type of company (e.g., "Private company") | String | | Lusha Popularity Tier | Lusha popularity tier | Integer | ### Industry | Field Name | Description | Data Type | | --- | --- | --- | | Main Industry | High-level industry sector (e.g., Finance, Technology) | String | | Sub Industry | Granular industry niche (e.g., Software Development) | String | | Specialities | Array of keywords defining core business activities | Array [String] | | SIC Code | SIC code | Integer | | SIC Description | Human-readable SIC description | String | | NAICS Code | NAICS code | Integer | | NAICS Description | Human-readable NAICS description | String | ### Location | Field Name | Description | Data Type | | --- | --- | --- | | City | HQ City | String | | State | HQ State/Province name | String | | State Code | Two-letter state or province code | String | | Country | Full country name | String | | Country ISO2 | Two-letter ISO country code | String | | Continent | Continent of the organization's HQ | String | | Raw Location | Full unformatted address string | String | | Coordinates | HQ coordinates as [Longitude, Latitude] | Array [Float] | | Company Locations | All known company locations (not just HQ) | Array [Object] | ### Social Links | Field Name | Description | Data Type | | --- | --- | --- | | LinkedIn | URL for the company's official LinkedIn page | URL | | LinkedIn Followers | LinkedIn followers count for the company | Integer | | Crunchbase | URL for the company's Crunchbase profile | URL | ### Funding | Field Name | Description | Data Type | | --- | --- | --- | | Total Rounds | Count of unique funding events | Integer | | Total Amount | Cumulative capital raised across all historical rounds | Integer | | Currency | Normalized currency for totals (usually USD) | String | | Is IPO | Boolean: True if the company is publicly traded | Boolean | | Last Round Type | Type of most recent event (e.g., Post-IPO Debt) | String | | Last Round Amount | Capital raised in the most recent event | Integer | | Last Round Date | Date of the most recent funding event | String | | Round Currency | Specific currency for a historical round | String | | Round Amount | Amount for a historical round | Integer | | Round Type | Classification for a historical round | String | | Round Date | Date for a historical round | String | ### Technographics & Intent | Field Name | Description | Data Type | | --- | --- | --- | | Technologies | Software/tools detected in the company's stack | Array [Object] | | Intent Topic Count | Number of topics showing active research interest | Integer | | Topic Name | Specific topic name (e.g., Sales Intelligence) | String | | Topic Score | Strength of the intent signal (0-100) | Integer | | Topic Trend | Trend velocity (e.g., "+17", "New", "-8") | String | ### Company Signals | Signal Type | Description | | --- | --- | | Website Traffic Increase Signal | Triggered when a company's website traffic increases significantly | | Website Traffic Decrease Signal | Triggered when a company's website traffic decreases significantly | | IT Spend Increase Signal | Triggered when a company's IT spending increases | | IT Spend Decrease Signal | Triggered when a company's IT spending decreases | | Surge in Hiring Signal | Triggered when a company shows a surge in overall hiring activity | | Surge in Hiring by Department Signal | Triggered when a company shows a surge in hiring for a specific department | | Surge in Hiring by Location Signal | Triggered when a company shows a surge in hiring in a specific location | | Headcount Increase 1M Signal | Triggered when a company's headcount increases over 1 month | | Headcount Increase 3M Signal | Triggered when a company's headcount increases over 3 months | | Headcount Increase 6M Signal | Triggered when a company's headcount increases over 6 months | | Headcount Increase 12M Signal | Triggered when a company's headcount increases over 12 months | | Headcount Decrease 1M Signal | Triggered when a company's headcount decreases over 1 month | | Headcount Decrease 3M Signal | Triggered when a company's headcount decreases over 3 months | | Headcount Decrease 6M Signal | Triggered when a company's headcount decreases over 6 months | | Headcount Decrease 12M Signal | Triggered when a company's headcount decreases over 12 months | | Commercial Activity News Signal | Partnership, New Customer, New Vendor | | Corporate Strategy News Signal | M&A, Facilities Expansion, New Location, Facility Closure, Asset Sale, Lawsuit Filed | | Financial Events News Signal | Funding Round, Asset Investment, Strategic Investment, IPO | | Market Intelligence News Signal | Event Participation, Recognition, Competitor Activity | | People News Signal | Executive Hire, Executive Departure, Executive Promotion, Headcount Increase, Headcount Decrease | | Product Activity News Signal | Product Launch, Product Development, Product Integration | | Risk News Signal | Security Issue, Lawsuit Faced | # API Endpoint Structure Complete endpoint documentation with inputs and outputs for each API capability, organized by data type. div details summary strong Contacts div details summary Enrichment Returns comprehensive contact and company data for a single person lookup. **Inputs** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | First Name | `firstName` | The contact's first name | String | | Last Name | `lastName` | The contact's last name | String | | Email | `email` | The contact's email address | String | | LinkedIn URL | `linkedinUrl` | The contact's LinkedIn profile URL | URL | | Company Name | `companyName` | Company name where the contact works | String | | Company Domain | `companyDomain` | The domain name of the company | String | | Refresh Job Info | `refreshJobInfo` | Set to true to refresh and update job details | Boolean | | Filter By | `filterBy` | Filter results (phoneNumbers, emailAddresses) | String | | Reveal Emails | `revealEmails` | Set to true to retrieve only email addresses | Boolean | | Reveal Phones | `revealPhones` | Set to true to retrieve only phone numbers | Boolean | | Partial Profile | `partialProfile` | Option to receive a partial profile | Boolean | **Outputs** **Enrichment Metadata** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Error | `contact.error` | Returns error details if the request failed; null if successful | Object | | Credit Charged | `contact.isCreditCharged` | Boolean indicating if a Lusha credit was consumed | Boolean | **Contact Personal Identity** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Person ID | `data.personId` | Lusha's unique internal identifier for the individual | Integer | | First Name | `data.firstName` | The contact's first name | String | | Last Name | `data.lastName` | The contact's last name | String | | Full Name | `data.fullName` | The concatenated first and last name | String | | Contact Tags | `data.contactTags[]` | Custom labels (e.g., "Decision maker", "Opportunity") with id, name, color | Array [Object] | | LinkedIn | `data.socialLinks.linkedin` | Validated URL for the contact's LinkedIn profile | URL | | X URL | `data.socialLinks.xUrl` | Twitter/X profile URL | String | **Social & Profile Data** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | LinkedIn Followers Count | `data.linkedinFollowersCount` | LinkedIn followers count | Integer | | LinkedIn Connections Count | `data.linkedinConnectionsCount` | LinkedIn connections count | Integer | | LinkedIn Certifications | `data.linkedinCertifications` | Professional certifications from LinkedIn | Array | | LinkedIn Courses | `data.linkedinCourses` | Courses listed on LinkedIn | Array | | LinkedIn Awards | `data.linkedinAwards` | Honors and awards from LinkedIn | Array | | LinkedIn Skills | `data.linkedinSkills` | Skills listed on LinkedIn profile | Array [String] | **Contact Information** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Email | `data.emailAddresses[].email` | The verified email address | String | | Email Type | `data.emailAddresses[].emailType` | Classification (e.g., work, personal) | String | | Email Update Date | `data.emailAddresses[].updateDate` | The date this specific email was last verified | Date | | Email Confidence | `data.emailAddresses[].emailConfidence` | Confidence score for deliverability (e.g., A+) | String | | Phone Number | `data.phoneNumbers[].number` | Phone number in international format | String | | Phone Type | `data.phoneNumbers[].phoneType` | Classification (e.g., mobile, direct, office) | String | | Do Not Call | `data.phoneNumbers[].doNotCall` | Boolean flag for DNC (Do Not Call) registry status | Boolean | | Phone Update Date | `data.phoneNumbers[].updateDate` | The date this specific phone was last verified | Date | **Contact Location** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Continent | `data.location.continent` | Continent name of the contact | String | | Country | `data.location.country` | Country name of the contact | String | | Country ISO2 | `data.location.country_iso2` | Two-letter ISO country code | String | | City | `data.location.city` | City name | String | | City ID | `data.location.city_id` | Lusha internal city identifier | Integer | | EU Contact | `data.location.is_eu_contact` | Boolean indicating if the contact is in the European Union | Boolean | | Coordinates | `data.location.location_coordinates` | Array [Longitude, Latitude] for the contact | Array [Float] | **Current Professional Data** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Job Title | `data.jobTitle.title` | The full, raw job title string | String | | Seniority | `data.jobTitle.seniority` | Standardized seniority (e.g., Vice President, Manager) | String | | Departments | `data.jobTitle.departments` | Array of functional business units (e.g., General Management) | Array | | Job Start Date | `data.jobStartDate` | The date the contact started their current role | Date | | Update Date | `data.updateDate` | The last time the contact record was updated | Date | **Career History** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Previous Company | `previousJob.company.name` | Name of the previous employer organization | String | | Previous Domain | `previousJob.company.domain` | The web domain of the previous employer | String | | Previous Title | `previousJob.jobTitle.title` | The title held at the previous company | String | | Previous Seniority | `previousJob.jobTitle.seniority` | The seniority level of the previous role | String | **Company Firmographics** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Company ID | `company.companyId` | Lusha's unique global identifier for the account | Integer | | Company Name | `company.name` | The full legal or trade name of the company | String | | Description | `company.description` | A summary of the company's business and value prop | String | | Homepage URL | `company.homepageUrl` | Primary website URL | URL | | FQDN | `company.fqdn` | Fully Qualified Domain Name | String | | Homepage Domain | `company.domains.homepage` | Root domain for the website | String | | Email Domain | `company.domains.email` | Root domain for email server | String | | Company Size | `company.companySize` | Array [Min, Max] of employee count | Array [Integer] | | Revenue Range | `company.revenueRange` | Array [Min, Max] of annual revenue (e.g., [1B, 10B]) | Array [Integer] | | Logo URL | `company.logoUrl` | URL for the organization's logo image | URL | | Main Industry | `company.mainIndustry` | The primary industry vertical | String | | Sub Industry | `company.subIndustry` | Granular industry niche | String | **Company Industry Codes** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | SIC Codes | `company.industryPrimaryGroupDetails.sics[]` | Standardized SIC codes and their descriptions | Array [Object] | | NAICS Codes | `company.industryPrimaryGroupDetails.naics[]` | Standardized NAICS codes and their descriptions | Array [Object] | **Company Location** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Continent | `company.location.continent` | Continent of the company HQ | String | | Country | `company.location.country` | Country of the company HQ | String | | State | `company.location.state` | State name for the HQ | String | | State Code | `company.location.stateCode` | Two-letter state code | String | | City | `company.location.city` | HQ City | String | | Raw Location | `company.location.rawLocation` | Full unformatted address string | String | | Coordinates | `company.location.locationCoordinates` | Array [Longitude, Latitude] for the company HQ | Array [Float] | **Company Socials** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | LinkedIn | `company.social.linkedin` | Company LinkedIn profile URL | URL | | Crunchbase | `company.social.crunchbase` | Company Crunchbase profile URL | URL | **Company Funding** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Total Rounds | `company.funding.totalRounds` | Total number of funding events | Integer | | Total Amount | `company.funding.totalRoundsAmount` | Total capital raised (Sum of all rounds) | Integer | | Currency | `company.funding.currency` | Currency code used for funding (e.g., USD) | String | | Last Round Type | `company.funding.lastRoundType` | E.g., Private Equity Round, Series C | String | | Last Round Amount | `company.funding.lastRoundAmount` | Capital raised in the most recent round | Integer | | Last Round Date | `company.funding.lastRoundDate` | Date of the most recent funding event | String | | Is IPO | `company.funding.isIpo` | Boolean: True if the company is public | Boolean | | Funding Rounds | `company.funding.rounds[]` | Detailed historical funding round data (roundAmount, roundType, roundDate) | Array [Object] | **Technographics & Intent** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Technologies | `company.technologies[].name` | Software/tools detected in the company's stack | Array [Object] | | Intent Topic Count | `company.intent.topicCount` | Total number of active intent topics | Integer | | Detected Topics | `company.intent.detectedTopics[]` | Specific topics of research interest and their scores/trends (topicName, metadata) | Array [Object] | details summary Prospecting Search Returns a list of contacts matching your search criteria with preview data and availability indicators. **Inputs** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Job Titles | `filters.contacts.jobTitles` | Job title keywords to filter by | Array [String] | | Seniority | `filters.contacts.seniority` | Seniority level IDs to filter by | Array [Integer] | | Departments | `filters.contacts.departments` | Department names to filter by | Array [String] | | Contact Countries | `filters.contacts.countries` | ISO2 country codes for contact location | Array [String] | | Contact Locations | `filters.contacts.locations` | Contact location objects (country, state, city) | Array [Object] | | Company Names | `filters.companies.names` | Company names to include | Array [String] | | Company Domains | `filters.companies.domains` | Company domains to include | Array [String] | | Company Locations | `filters.companies.locations` | Company HQ location objects | Array [Object] | | Company Size | `filters.companies.sizesFilterOption` | Employee count range objects (min, max) | Array [Object] | | Revenue | `filters.companies.revenues` | Revenue range objects (min, max) | Array [Object] | | Industries | `filters.companies.mainIndustriesIds` | Main industry IDs to filter by | Array [Integer] | | Sub Industries | `filters.companies.subIndustriesIds` | Sub industry IDs to filter by | Array [Integer] | | SIC Codes | `filters.companies.sicsCodes` | SIC codes to filter by | Array [String] | | NAICS Codes | `filters.companies.naicsCodes` | NAICS codes to filter by | Array [String] | | Signal Types | `filters.signals.signalTypes` | Signal types to filter by (companyChange, promotion) | Array [String] | | Page | `pages.page` | Page number for pagination (0-indexed) | Integer | | Page Length | `pages.pageLength` | Number of results per page | Integer | **Outputs** **Search Metadata** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Request ID | `requestId` | Unique ID assigned to the specific search query session | String | | Current Page | `currentPage` | The current page index of the results set | Integer | | Page Length | `pageLength` | Number of results returned per page (e.g., 50) | Integer | | Total Results | `totalResults` | Total number of contacts found matching the search criteria | Integer | **Contact Identity** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Name | `data[].name` | The full name of the contact | String | | Contact ID | `data[].contactId` | Lusha's unique internal UUID for the contact record | String (UUID) | | Person ID | `data[].personId` | Numerical identifier for the contact | Integer | **Contact Job Data** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Job Title | `data[].jobTitle` | The raw professional title of the contact | String | **Company Information** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Company ID | `data[].companyId` | Lusha's unique global identifier for the company | Integer | | Company Name | `data[].companyName` | Legal or trade name of the employer | String | | FQDN | `data[].fqdn` | Fully Qualified Domain Name of the company website | String | | Description | `data[].companyDescription` | Brief textual bio of the organization | String | | Logo URL | `data[].logoUrl` | CDN link to the company's brand logo | URL | **Data Availability Indicators** Use these boolean flags to understand what data is available before enrichment. | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Is Shown | `data[].isShown` | Boolean indicating if this record is currently visible/accessible | Boolean | | Has Department | `data[].hasDepartment` | True if department classification is available | Boolean | | Has Seniority | `data[].hasSeniority` | True if seniority level data is available | Boolean | | Has Contact Location | `data[].hasContactLocation` | True if the contact's location is known | Boolean | | Has Social Link | `data[].hasSocialLink` | True if a LinkedIn or social profile is available | Boolean | **Email Availability** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Has Emails | `data[].hasEmails` | True if Lusha has at least one email for this contact | Boolean | | Has Work Email | `data[].hasWorkEmail` | True if a verified corporate email is available | Boolean | | Has Private Email | `data[].hasPrivateEmail` | True if a personal email address is available | Boolean | **Phone Availability** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Has Phones | `data[].hasPhones` | True if Lusha has at least one phone number | Boolean | | Has Mobile Phone | `data[].hasMobilePhone` | True if a direct mobile number is available | Boolean | | Has Direct Phone | `data[].hasDirectPhone` | True if a direct office/desk line is available | Boolean | **Company Data Availability** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Has Employees Count | `data[].hasCompanyEmployeesCount` | True if company size data is available | Boolean | | Has Revenue | `data[].hasCompanyRevenue` | True if estimated revenue data is available | Boolean | | Has Main Industry | `data[].hasCompanyMainIndustry` | True if high-level industry data is available | Boolean | | Has Sub Industry | `data[].hasCompanySubIndustry` | True if granular industry data is available | Boolean | | Has Funding | `data[].hasCompanyFunding` | True if the company has recorded funding rounds | Boolean | | Has Intent | `data[].hasCompanyIntent` | True if active intent signals are being tracked | Boolean | | Has Technologies | `data[].hasCompanyTechnologies` | True if tech stack data is available | Boolean | | Has City | `data[].hasCompanyCity` | True if the HQ city is known | Boolean | | Has Country | `data[].hasCompanyCountry` | True if the HQ country is known | Boolean | **Billing Metadata** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Credits Charged | `billing.creditsCharged` | Number of credits deducted for the search request | Integer | | Results Returned | `billing.resultsReturned` | Number of data objects included in the current response | Integer | details summary Prospecting Enrich Returns full contact details for selected contacts from search results. **Inputs** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Request ID | `requestId` | The requestId from the Prospecting Search response | String (UUID) | | Contact IDs | `contactIds` | Array of contact IDs to enrich (max 100) | Array [String] | | Reveal Emails | `revealEmails` | Set to true to retrieve only email addresses | Boolean | | Reveal Phones | `revealPhones` | Set to true to retrieve only phone numbers | Boolean | **Outputs** **Request Metadata** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Request ID | `requestId` | Unique ID for the enrichment session | String | | Credits Charged | `creditsCharged` | Number of credits consumed for this specific enrichment | Integer | **Status Flags** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Contact ID | `contacts[].id` | The Contact UUID (links back to search results) | String (UUID) | | Is Success | `contacts[].isSuccess` | Boolean: Indicates if the enrichment was successful | Boolean | | Error | `contacts[].error` | Error details if isSuccess is false | Object/Null | **Contact Identity** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Person ID | `data.personId` | Lusha's numerical unique ID for the person | Integer | | First Name | `data.firstName` | Individual's given name | String | | Last Name | `data.lastName` | Individual's family name | String | | Full Name | `data.fullName` | Concatenated name | String | | Is Shown | `data.isShown` | Boolean indicating if the contact is visible in the UI | Boolean | **Contact Job Data** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Job Title | `data.jobTitle` | The full raw professional title | String | | Departments | `data.departments[]` | Array of functional business units (e.g., Engineering) | Array [String] | | Seniority | `data.seniority[]` | Array of seniority objects containing id and value | Array [Object] | **Contact Location** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Country | `data.location.country` | Country name for the contact | String | | Continent | `data.location.continent` | Continent name for the contact | String | **Contact Information** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Email | `data.emailAddresses[].email` | The revealed email address | String | | Email Type | `data.emailAddresses[].emailType` | Classification (work/personal) | String | | Email Confidence | `data.emailAddresses[].emailConfidence` | Deliverability grade | String | | Email Update Date | `data.emailAddresses[].updateDate` | ISO Timestamp of the last email verification | DateTime | | Phone Number | `data.phoneNumbers[].number` | Revealed phone string | String | | Phone Type | `data.phoneNumbers[].phoneType` | Phone classification | String | | LinkedIn | `data.socialLinks.linkedin` | The contact's LinkedIn profile URL | URL | **Company Information** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Company ID | `data.companyId` | Global ID of the organization | Integer | | Company Name | `data.companyName` | Legal name of the organization | String | | FQDN | `data.company.fqdn` | Fully Qualified Domain Name | String | | Description | `data.company.description` | Company bio | String | | Logo URL | `data.company.logoUrl` | Brand logo URL | URL | | Employees | `data.company.employees` | String representation of headcount (e.g., "100-500") | String | | Revenue Range | `data.company.revenueRange` | Array [Min, Max] of estimated annual revenue | Array [Integer] | | Main Industry | `data.company.mainIndustry` | High-level industry sector | String | | Sub Industry | `data.company.subIndustry` | Granular industry vertical | String | **Company Location** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | City | `data.company.location.city` | HQ City | String | | State | `data.company.location.state` | HQ State name | String | | State Code | `data.company.location.state_code` | 2-letter state code | String | | Country | `data.company.location.country` | HQ Country name | String | | Country ISO2 | `data.company.location.country_iso2` | ISO country code | String | | Raw Location | `data.company.location.raw_location` | Full unformatted HQ address string | String | | Coordinates | `data.company.location.location_coordinates` | HQ [Longitude, Latitude] array | Array [Float] | **Company Socials** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | LinkedIn | `data.company.linkedin` | Official company LinkedIn page | URL | | Crunchbase | `data.company.crunchbase` | Company Crunchbase profile | URL | details summary Signals Returns professional change signals (promotions, job changes) for tracked contacts. **Inputs** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Contact IDs | `contactIds` | Array of Lusha contact IDs to retrieve signals for | Array [Integer] | | Signals | `signals` | Signal types to retrieve (allSignals, promotion, companyChange) | Array [String] | | Start Date | `startDate` | Start date for signal retrieval (YYYY-MM-DD) | Date | **Outputs** **Usage Metadata** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Start Date | `startDate` | The beginning of the signal tracking window | Date (YYYY-MM-DD) | | End Date | `endDate` | The end of the signal tracking window | Date (YYYY-MM-DD) | | Credit Charged | `creditCharged` | Total credits consumed for this batch retrieval | Integer | **Contact ID Key** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Person ID | `contacts.{id}.personId` | The unique Lusha identifier for the contact | Integer/String | **Company Change Signal** Triggered when a contact moves to a new organization. | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Person ID | `contacts.{id}.companyChange[].personId` | Person identifier within the signal object | Integer/String | | Current Company ID | `contacts.{id}.companyChange[].currentCompanyId` | Lusha ID of the new organization | Integer | | Current Company Name | `contacts.{id}.companyChange[].currentCompanyName` | Name of the organization the person joined | String | | Current Domain | `contacts.{id}.companyChange[].currentDomain` | Web domain of the new organization | String | | Current Title | `contacts.{id}.companyChange[].currentTitle` | The person's new job title | String | | Current Seniority | `contacts.{id}.companyChange[].currentSeniorityLabel` | Standardized seniority level (e.g., "c-suite", "director") | String | | Current Departments | `contacts.{id}.companyChange[].currentDepartments` | Functional business unit(s) for the new role | Array [Object/String] | | Previous Company Name | `contacts.{id}.companyChange[].previousCompanyName` | Name of the employer the person recently left | String | | Previous Domain | `contacts.{id}.companyChange[].previousDomain` | Web domain of the previous employer | String | | Signal Date | `contacts.{id}.companyChange[].signalDate` | Date the change was detected or became effective | Date (YYYY-MM-DD) | **Promotion Signal** Triggered when a contact is promoted within their organization. | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Current Company ID | `contacts.{id}.promotion[].currentCompanyId` | Lusha ID of the organization where the promotion occurred | Integer | | Current Company Name | `contacts.{id}.promotion[].currentCompanyName` | Name of the organization where the promotion occurred | String | | Current Domain | `contacts.{id}.promotion[].currentDomain` | Web domain of the organization | String | | Current Title | `contacts.{id}.promotion[].currentTitle` | The contact's new, higher-level title | String | | Current Seniority | `contacts.{id}.promotion[].currentSeniorityLabel` | Updated standardized seniority level | String | | Current Departments | `contacts.{id}.promotion[].currentDepartments` | Functional business unit(s) for the promoted role | Array [Object/String] | | Signal Date | `contacts.{id}.promotion[].signalDate` | Date the promotion was detected | Date (YYYY-MM-DD) | details summary Lookalikes Returns contacts similar to your reference contacts based on professional attributes. **Inputs** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Person IDs | `personIds` | Array of Lusha person IDs to use as reference | Array [Integer] | **Outputs** **Search Metadata** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Request ID | `requestId` | Unique session identifier for the lookalike query | String | | Count | `count` | Total number of lookalike contacts returned in the response | Integer | | Credits Charged | `creditsCharged` | Number of credits consumed to generate the lookalike list | Integer | **Contact Details** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Person ID | `contacts[].personId` | Lusha's numerical unique identifier for the lookalike contact | String/Integer | | Name | `contacts[].name` | Full name of the lookalike contact | String | | Job Title | `contacts[].jobTitle` | The raw professional title of the lookalike contact | String | | Company ID | `contacts[].companyId` | Lusha's unique global identifier for the lookalike's organization | String/Integer | | Company Name | `contacts[].companyName` | The full name of the organization where the lookalike works | String | div details summary strong Companies div details summary Enrichment Returns comprehensive company data including firmographics, funding, and intent signals. **Inputs** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Domain | `domain` | Company website domain | String | | Company Name | `companyName` | Legal or trade name of the company | String | | Lusha Company ID | `lushaCompanyId` | Lusha's unique company identifier | Integer | | LinkedIn Company ID | `CompanyId` | LinkedIn unique company identifier | Integer | **Outputs** **Platform IDs** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | LinkedIn Company ID | `id` | Permanent unique identifier for the company on LinkedIn | Integer | | Lusha Company ID | `lushaCompanyId` | Lusha's unique internal global identifier for the organization | String | **Firmographics** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Name | `name` | Legal or common trade name of the company | String | | FQDN | `fqdn` | Fully Qualified Domain Name (e.g., www.citigroup.com) | String | | Founded | `founded` | The year the organization was established | String | | Description | `description` | Comprehensive textual bio or mission statement | String | | Logo URL | `logoUrl` | CDN link to the company's brand logo image | URL | | Alternative Name | `alternativeName` | Normalized alternative company name | String | | Company Type | `companyType` | Type of company (e.g., "Private company") | String | | Lusha Popularity Tier | `lushaPopularityTier` | Lusha popularity tier | Integer | | Email Domain | `emailDomain` | Company email domain | String | **Size & Revenue** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Company Size | `companySize` | Array containing [Min, Max] employee count range | Array [Integer] | | Revenue Range | `revenueRange` | Array containing [Min, Max] annual revenue range | Array [Integer] | **Industry & Focus** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Main Industry | `mainIndustry` | High-level industry sector (e.g., Finance, Technology) | String | | Sub Industry | `subIndustry` | Granular industry niche (e.g., Software Development) | String | | Specialities | `specialities` | Array of keywords defining core business activities | Array [String] | **Industry Codes** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | SIC Code | `industryPrimaryGroupDetails.sics[].sic` | SIC code | Integer | | SIC Description | `industryPrimaryGroupDetails.sics[].description` | Human-readable SIC description | String | | NAICS Code | `industryPrimaryGroupDetails.naics[].naics` | NAICS code | Integer | | NAICS Description | `industryPrimaryGroupDetails.naics[].description` | Human-readable NAICS description | String | **Location** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | City | `city` | HQ City | String | | State | `state` | HQ State/Province name | String | | Country | `country` | Full country name | String | | Country ISO2 | `countryIso2` | Two-letter ISO country code | String | | Continent | `continent` | Continent of the organization's HQ | String | | Raw Location | `rawLocation` | Full unformatted address string | String | | Company Locations | `companyLocations` | All known company locations (not just HQ) | Array [Object] | **Social Links** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | LinkedIn | `linkedin` | URL for the company's official LinkedIn page | URL | | LinkedIn Followers | `linkedinFollowers` | LinkedIn followers count for the company | Integer | | Crunchbase | `crunchbase` | URL for the company's Crunchbase profile | URL | **Funding** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Total Rounds | `funding.totalRounds` | Count of unique funding events | Integer | | Total Amount | `funding.totalRoundsAmount` | Cumulative capital raised across all historical rounds | Integer | | Currency | `funding.currency` | Normalized currency for totals (usually USD) | String | | Is IPO | `funding.isIpo` | Boolean: True if the company is publicly traded | Boolean | | Last Round Type | `funding.lastRoundType` | Type of most recent event (e.g., Post-IPO Debt) | String | | Last Round Amount | `funding.lastRoundAmount` | Capital raised in the most recent event | Integer | | Last Round Date | `funding.lastRoundDate` | Date of the most recent funding event | String | | Round Currency | `funding.rounds[].currency` | Specific currency for a historical round | String | | Round Amount | `funding.rounds[].roundAmount` | Amount for a historical round | Integer | | Round Type | `funding.rounds[].roundType` | Classification for a historical round | String | | Round Date | `funding.rounds[].roundDate` | Date for a historical round | String | **Intent Data** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Topic Count | `intent.topicCount` | Number of topics showing active research interest | Integer | | Topic Name | `intent.detectedTopics[].topicName` | Specific topic name (e.g., Sales Intelligence) | String | | Topic Score | `intent.detectedTopics[].topicScore` | Strength of the intent signal (0-100) | Integer | | Topic Trend | `intent.detectedTopics[].topicTrend` | Trend velocity (e.g., "+17", "New", "-8") | String | details summary Prospecting Search Returns a list of companies matching your search criteria with preview data. **Inputs** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Company Names | `filters.companies.names` | Company names to include | Array [String] | | Company Domains | `filters.companies.domains` | Company domains to include | Array [String] | | Company Locations | `filters.companies.locations` | Company HQ location objects (country, state, city) | Array [Object] | | Company Size | `filters.companies.sizesFilterOption` | Employee count range objects (min, max) | Array [Object] | | Revenue | `filters.companies.revenues` | Revenue range objects (min, max) | Array [Object] | | Main Industries | `filters.companies.mainIndustriesIds` | Main industry IDs to filter by | Array [Integer] | | Sub Industries | `filters.companies.subIndustriesIds` | Sub industry IDs to filter by | Array [Integer] | | Technologies | `filters.companies.technologies` | Technology names to filter by | Array [String] | | Intent Topics | `filters.companies.intentTopics` | Intent topic names to filter by | Array [String] | | SIC Codes | `filters.companies.sicsCodes` | SIC codes to filter by | Array [String] | | NAICS Codes | `filters.companies.naicsCodes` | NAICS codes to filter by | Array [String] | | Signal Types | `filters.signals.signalTypes` | Signal types to filter by | Array [String] | | Page | `pages.page` | Page number for pagination (0-indexed) | Integer | | Page Length | `pages.pageLength` | Number of results per page | Integer | **Outputs** **Search Metadata** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Request ID | `requestId` | Unique session identifier for the specific query | String | | Current Page | `currentPage` | The current page number in the paginated results | Integer | | Page Length | `pageLength` | The number of results returned per page | Integer | | Total Results | `totalResults` | Total number of companies matching the search criteria | Integer | **Company Identity** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | ID | `data[].id` | LinkedIn Company ID, permanent unique identifier | String/Integer | | Name | `data[].name` | The full legal or common name of the company | String | | FQDN | `data[].fqdn` | Fully Qualified Domain Name, e.g. www.oatey.com | String | | Description | `data[].description` | A textual overview of the company's business and mission | String | | Logo URL | `data[].logoUrl` | Public URL for the company's logo asset | URL | **Data Availability Flags** Use these boolean flags to understand what data is available before enrichment. | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Has Employees Count | `data[].hasCompanyEmployeesCount` | True if headcount range data is available | Boolean | | Has Revenue | `data[].hasCompanyRevenue` | True if annual revenue data is available | Boolean | | Has Main Industry | `data[].hasCompanyMainIndustry` | True if the primary industry sector is identified | Boolean | | Has Sub Industry | `data[].hasCompanySubIndustry` | True if the granular industry niche is identified | Boolean | | Has Funding | `data[].hasCompanyFunding` | True if the company has recorded funding rounds | Boolean | | Has Intent | `data[].hasCompanyIntent` | True if active intent topics are being tracked | Boolean | | Has Technologies | `data[].hasCompanyTechnologies` | True if tech stack or technography data is available | Boolean | | Has City | `data[].hasCompanyCity` | True if the HQ city location is available | Boolean | | Has Country | `data[].hasCompanyCountry` | True if the HQ country location is available | Boolean | details summary Prospecting Enrich Returns full company details for selected companies from search results. **Inputs** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Request ID | `requestId` | The requestId from the Prospecting Search response | String (UUID) | | Company IDs | `companyIds` | Array of company IDs to enrich (max 50) | Array [String] | **Outputs** **Search Metadata** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Request ID | `requestId` | Unique ID for the enrichment session | String | **Company Identity** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | ID | `companies[].id` | LinkedIn Company ID, unique identifier on the LinkedIn platform | Integer | | Name | `companies[].name` | The full legal or common name of the company | String | | FQDN | `companies[].fqdn` | Fully Qualified Domain Name, e.g. www.jameshardie.com | String | | Description | `companies[].description` | Comprehensive textual bio or mission statement | String | | Founded | `companies[].founded` | The year the organization was established | Integer | | Logo URL | `companies[].logoUrl` | CDN link to the company's brand logo image | URL | **Web Domains** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Homepage Domain | `companies[].domains.homepage` | Root domain for the corporate website | String | | Email Domain | `companies[].domains.email` | Primary domain used for corporate email addresses | String | **Size & Revenue** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Size Min | `companies[].companySize.min` | Lower bound of employee headcount | Integer | | Size Max | `companies[].companySize.max` | Upper bound of employee headcount | Integer | | LinkedIn Employees | `companies[].companySize.employees_in_linkedin` | Actual count of employees identified on LinkedIn | Integer | | Employees | `companies[].employees` | Formatted string of the headcount range, e.g. "5001 - 10000" | String | | Revenue Range | `companies[].revenueRange` | Estimated annual revenue range as [Min, Max] | Array [Integer] | **Industry & Focus** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Main Industry | `companies[].mainIndustry` | High-level industry sector | String | | Sub Industry | `companies[].subIndustry` | Granular industry niche | String | | Specialities | `companies[].specialities` | Keywords defining core business activities | Array [String] | **Industry Codes** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | SIC Code | `industryPrimaryGroupDetails.sics[].sic` | SIC code | Integer | | SIC Description | `industryPrimaryGroupDetails.sics[].description` | Human-readable SIC description | String | | NAICS Code | `industryPrimaryGroupDetails.naics[].naics` | NAICS code | Integer | | NAICS Description | `industryPrimaryGroupDetails.naics[].description` | Human-readable NAICS description | String | **HQ Location** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | City | `companies[].city` | HQ city | String | | State | `companies[].state` | HQ state name | String | | State Code | `companies[].stateCode` | Two-letter state or province code, e.g. IL | String | | Country | `companies[].country` | Full country name | String | | Country ISO2 | `companies[].countryIso2` | Two-letter ISO code | String | | Continent | `companies[].continent` | Continent of the organization's HQ | String | | Raw Location | `companies[].rawLocation` | Full unformatted address string | String | | Coordinates | `companies[].coordinates` | HQ coordinates as [Longitude, Latitude] | Array [Float] | **Social Links** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | LinkedIn | `companies[].social.linkedin` | URL for the company's official LinkedIn page | URL | | Crunchbase | `companies[].social.crunchbase` | URL for the company's Crunchbase profile | URL | **Intent Data** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Topic Count | `intent.topicCount` | Number of topics currently showing research interest | Integer | | Topic Name | `intent.detectedTopics[].topicName` | Specific topic name, e.g. Sales Intelligence Platform | String | | Topic Score | `intent.detectedTopics[].metadata.topicScore` | Strength of the intent signal from 0 to 100 | Integer | | Topic Trend | `intent.detectedTopics[].metadata.topicTrend` | Trend velocity, e.g. "New", "-13" | String | details summary Signals Returns business change signals for tracked companies including website traffic, IT spend, headcount changes, hiring surges, and news events. **Inputs** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Company IDs | `companyIds` | Array of Lusha company IDs to retrieve signals for | Array [Integer] | | Signals | `signals` | Signal types to retrieve (allSignals, websiteTrafficIncrease, websiteTrafficDecrease, itSpendIncrease, itSpendDecrease, surgeInHiring, surgeInHiringByDepartment, surgeInHiringByLocation, headcountIncrease1m, headcountIncrease3m, headcountIncrease6m, headcountIncrease12m, headcountDecrease1m, headcountDecrease3m, headcountDecrease6m, headcountDecrease12m, commercialActivityNews, corporateStrategyNews, financialEventsNews, marketIntelligenceNews, peopleNews, productActivityNews, riskNews) | Array [String] | | Start Date | `startDate` | Start date for signal retrieval (YYYY-MM-DD) | Date | **Outputs** **Usage Metadata** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Start Date | `startDate` | The start of the timeframe tracked for these signals | Date | | End Date | `endDate` | The end of the timeframe tracked for these signals | Date | | Credit Charged | `creditCharged` | Total credits consumed for this request | Integer | **Base Company Data** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Company ID | `companies.{id}.companyId` | Lusha's unique numerical ID for the organization | String | | Company Name | `companies.{id}.companyName` | The full legal or common name of the company | String | | Domain | `companies.{id}.domain` | The primary web domain of the organization | String | **Website Traffic Increase Signal** Triggered when a company's website traffic increases significantly. | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Company ID | `websiteTrafficIncrease[].companyId` | Lusha's unique identifier for the company | Integer | | Signal ID | `websiteTrafficIncrease[].signalId` | Unique identifier for this signal instance | Integer | | Signal Date | `websiteTrafficIncrease[].signalDate` | The date the traffic change was recorded | Date (YYYY-MM-DD) | | Historical Avg | `websiteTrafficIncrease[].historicalAvg` | Historical average monthly visits | Integer | | Last Month Visits | `websiteTrafficIncrease[].lastMonthVisits` | Number of visits in the last month | Integer | | Change Rate Percent | `websiteTrafficIncrease[].changeRatePercent` | Percentage change in traffic (e.g., "458") | String | **Website Traffic Decrease Signal** Triggered when a company's website traffic decreases significantly. | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Company ID | `websiteTrafficDecrease[].companyId` | Lusha's unique identifier for the company | Integer | | Signal ID | `websiteTrafficDecrease[].signalId` | Unique identifier for this signal instance | Integer | | Signal Date | `websiteTrafficDecrease[].signalDate` | The date the traffic change was recorded | Date (YYYY-MM-DD) | | Historical Avg | `websiteTrafficDecrease[].historicalAvg` | Historical average monthly visits | Integer | | Last Month Visits | `websiteTrafficDecrease[].lastMonthVisits` | Number of visits in the last month | Integer | | Change Rate Percent | `websiteTrafficDecrease[].changeRatePercent` | Percentage change in traffic (e.g., "-64") | String | **IT Spend Increase Signal** Triggered when a company's IT spending increases. | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Company ID | `itSpendIncrease[].companyId` | Lusha's unique identifier for the company | Integer | | Signal ID | `itSpendIncrease[].signalId` | Unique identifier for this signal instance | Integer | | Signal Date | `itSpendIncrease[].signalDate` | The date the spend change was recorded | Date (YYYY-MM-DD) | | Historical Avg | `itSpendIncrease[].historicalAvg` | Historical average estimated annual IT spend (in $) | Integer | | New Value | `itSpendIncrease[].newValue` | Current estimated annual IT spend value (in $) | Integer | | Change Rate Percent | `itSpendIncrease[].changeRatePercent` | Percentage change in IT spend | String | **IT Spend Decrease Signal** Triggered when a company's IT spending decreases. | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Company ID | `itSpendDecrease[].companyId` | Lusha's unique identifier for the company | Integer | | Signal ID | `itSpendDecrease[].signalId` | Unique identifier for this signal instance | Integer | | Signal Date | `itSpendDecrease[].signalDate` | The date the spend change was recorded | Date (YYYY-MM-DD) | | Historical Avg | `itSpendDecrease[].historicalAvg` | Historical average estimated annual IT spend (in $) | Integer | | New Value | `itSpendDecrease[].newValue` | Current estimated annual IT spend value (in $) | Integer | | Change Rate Percent | `itSpendDecrease[].changeRatePercent` | Percentage change in IT spend | String | **Surge in Hiring Signal** Triggered when a company shows a surge in overall hiring activity. | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Company ID | `surgeInHiring[].companyId` | Lusha's unique identifier for the company | Integer | | Signal ID | `surgeInHiring[].signalId` | Unique identifier for this signal instance | Integer | | Signal Date | `surgeInHiring[].signalDate` | The date the hiring surge was detected | Date (YYYY-MM-DD) | | New Jobs Posted Last Week | `surgeInHiring[].newJobsPostedLastWeek` | Number of new job postings in the last week | Integer | | Historical Avg | `surgeInHiring[].historicalAvg` | Historical weekly average job postings | Integer | | Change Rate Percent | `surgeInHiring[].changeRatePercent` | Percentage change in job postings | Integer | **Surge in Hiring by Department Signal** Triggered when a company shows a surge in hiring for a specific department. | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Company ID | `surgeInHiringByDepartment[].companyId` | Lusha's unique identifier for the company | Integer | | Signal ID | `surgeInHiringByDepartment[].signalId` | Unique identifier for this signal instance | Integer | | Signal Date | `surgeInHiringByDepartment[].signalDate` | The date the hiring surge was detected | Date (YYYY-MM-DD) | | Department | `surgeInHiringByDepartment[].department` | The department with increased hiring | String | | New Jobs Posted Last 4 Weeks | `surgeInHiringByDepartment[].newJobsPostedLast4Weeks` | Number of new department job postings in the last 4 weeks | Integer | | Historical Avg | `surgeInHiringByDepartment[].historicalAvg` | Historical monthly average department job postings (4 weeks moving window) | Integer | | Change Rate Percent | `surgeInHiringByDepartment[].changeRatePercent` | Percentage change in department job postings | Integer | **Surge in Hiring by Location Signal** Triggered when a company shows a surge in hiring in a specific location. | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Company ID | `surgeInHiringByLocation[].companyId` | Lusha's unique identifier for the company | Integer | | Signal ID | `surgeInHiringByLocation[].signalId` | Unique identifier for this signal instance | Integer | | Signal Date | `surgeInHiringByLocation[].signalDate` | The date the hiring surge was detected | Date (YYYY-MM-DD) | | Location | `surgeInHiringByLocation[].location` | The location with increased hiring | String | | New Jobs Posted Last 4 Weeks | `surgeInHiringByLocation[].newJobsPostedLast4Weeks` | Number of new location job postings in the last 4 weeks | Integer | | Historical Avg | `surgeInHiringByLocation[].historicalAvg` | Historical monthly average location job postings (4 weeks moving window) | Integer | | Change Rate Percent | `surgeInHiringByLocation[].changeRatePercent` | Percentage change in location job postings | Integer | **Headcount Increase 1M Signal** Triggered when a company's headcount increases over 1 month. | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Company ID | `headcountIncrease1m[].companyId` | Lusha's unique identifier for the company | Integer | | Signal ID | `headcountIncrease1m[].signalId` | Unique identifier for this signal instance | Integer | | Signal Date | `headcountIncrease1m[].signalDate` | The date the headcount change was recorded | Date (YYYY-MM-DD) | | Baseline Employees Count | `headcountIncrease1m[].baselineEmployeesCount` | Employee count at baseline (1 month ago) | Integer | | New Employees Count | `headcountIncrease1m[].newEmployeesCount` | Current employee count | Integer | | Change Rate Percent | `headcountIncrease1m[].changeRatePercent` | Percentage change in headcount (e.g., "20") | String | **Headcount Increase 3M Signal** Triggered when a company's headcount increases over 3 months. | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Company ID | `headcountIncrease3m[].companyId` | Lusha's unique identifier for the company | Integer | | Signal ID | `headcountIncrease3m[].signalId` | Unique identifier for this signal instance | Integer | | Signal Date | `headcountIncrease3m[].signalDate` | The date the headcount change was recorded | Date (YYYY-MM-DD) | | Baseline Employees Count | `headcountIncrease3m[].baselineEmployeesCount` | Employee count over the previous 3 months | Integer | | New Employees Count | `headcountIncrease3m[].newEmployeesCount` | Current employee count | Integer | | Change Rate Percent | `headcountIncrease3m[].changeRatePercent` | Percentage change in headcount (e.g., "38") | String | **Headcount Increase 6M Signal** Triggered when a company's headcount increases over 6 months. | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Company ID | `headcountIncrease6m[].companyId` | Lusha's unique identifier for the company | Integer | | Signal ID | `headcountIncrease6m[].signalId` | Unique identifier for this signal instance | Integer | | Signal Date | `headcountIncrease6m[].signalDate` | The date the headcount change was recorded | Date (YYYY-MM-DD) | | Baseline Employees Count | `headcountIncrease6m[].baselineEmployeesCount` | Employee count over the previous 6 months | Integer | | New Employees Count | `headcountIncrease6m[].newEmployeesCount` | Current employee count | Integer | | Change Rate Percent | `headcountIncrease6m[].changeRatePercent` | Percentage change in headcount (e.g., "41") | String | **Headcount Increase 12M Signal** Triggered when a company's headcount increases over 12 months. | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Company ID | `headcountIncrease12m[].companyId` | Lusha's unique identifier for the company | Integer | | Signal ID | `headcountIncrease12m[].signalId` | Unique identifier for this signal instance | Integer | | Signal Date | `headcountIncrease12m[].signalDate` | The date the headcount change was recorded | Date (YYYY-MM-DD) | | Baseline Employees Count | `headcountIncrease12m[].baselineEmployeesCount` | Employee count over the previous 12 months | Integer | | New Employees Count | `headcountIncrease12m[].newEmployeesCount` | Current employee count | Integer | | Change Rate Percent | `headcountIncrease12m[].changeRatePercent` | Percentage change in headcount (e.g., "40") | String | **Headcount Decrease 1M Signal** Triggered when a company's headcount decreases over 1 month. | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Company ID | `headcountDecrease1m[].companyId` | Lusha's unique identifier for the company | Integer | | Signal ID | `headcountDecrease1m[].signalId` | Unique identifier for this signal instance | Integer | | Signal Date | `headcountDecrease1m[].signalDate` | The date the headcount change was recorded | Date (YYYY-MM-DD) | | Baseline Employees Count | `headcountDecrease1m[].baselineEmployeesCount` | Employee count at baseline (1 month ago) | Integer | | New Employees Count | `headcountDecrease1m[].newEmployeesCount` | Current employee count | Integer | | Change Rate Percent | `headcountDecrease1m[].changeRatePercent` | Percentage change in headcount (e.g., "-14") | String | **Headcount Decrease 3M Signal** Triggered when a company's headcount decreases over 3 months. | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Company ID | `headcountDecrease3m[].companyId` | Lusha's unique identifier for the company | Integer | | Signal ID | `headcountDecrease3m[].signalId` | Unique identifier for this signal instance | Integer | | Signal Date | `headcountDecrease3m[].signalDate` | The date the headcount change was recorded | Date (YYYY-MM-DD) | | Baseline Employees Count | `headcountDecrease3m[].baselineEmployeesCount` | Employee count over the previous 3 months | Integer | | New Employees Count | `headcountDecrease3m[].newEmployeesCount` | Current employee count | Integer | | Change Rate Percent | `headcountDecrease3m[].changeRatePercent` | Percentage change in headcount (e.g., "-10") | String | **Headcount Decrease 6M Signal** Triggered when a company's headcount decreases over 6 months. | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Company ID | `headcountDecrease6m[].companyId` | Lusha's unique identifier for the company | Integer | | Signal ID | `headcountDecrease6m[].signalId` | Unique identifier for this signal instance | Integer | | Signal Date | `headcountDecrease6m[].signalDate` | The date the headcount change was recorded | Date (YYYY-MM-DD) | | Baseline Employees Count | `headcountDecrease6m[].baselineEmployeesCount` | Employee count over the previous 6 months | Integer | | New Employees Count | `headcountDecrease6m[].newEmployeesCount` | Current employee count | Integer | | Change Rate Percent | `headcountDecrease6m[].changeRatePercent` | Percentage change in headcount (e.g., "-20") | String | **Headcount Decrease 12M Signal** Triggered when a company's headcount decreases over 12 months. | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Company ID | `headcountDecrease12m[].companyId` | Lusha's unique identifier for the company | Integer | | Signal ID | `headcountDecrease12m[].signalId` | Unique identifier for this signal instance | Integer | | Signal Date | `headcountDecrease12m[].signalDate` | The date the headcount change was recorded | Date (YYYY-MM-DD) | | Baseline Employees Count | `headcountDecrease12m[].baselineEmployeesCount` | Employee count over the previous 12 months | Integer | | New Employees Count | `headcountDecrease12m[].newEmployeesCount` | Current employee count | Integer | | Change Rate Percent | `headcountDecrease12m[].changeRatePercent` | Percentage change in headcount | String | **Commercial Activity News Signal** Partnership, New Customer, New Vendor. | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Event Type | `commercialActivityNews[].eventType` | Granular event type (e.g., Partnership, New Customer, New Vendor) | String | | Event Category | `commercialActivityNews[].eventCategory` | Broad business grouping | String | | Event Summary | `commercialActivityNews[].eventSummary` | A short, AI-generated summary of the event | String | | Event Effective Date | `commercialActivityNews[].eventEffectiveDate` | The actual date the event took place (if known) | Date/Null | | Article Title | `commercialActivityNews[].articleTitle` | The headline of the news source | String | | Article Sentence | `commercialActivityNews[].articleSentence` | A specific quote/snippet from the news article | String | | Article URL | `commercialActivityNews[].articleUrl` | Direct link to the source news article | URL | | Article Published Date | `commercialActivityNews[].articlePublishedDate` | The date the article was published | Date | **Corporate Strategy News Signal** M&A, Facilities Expansion, New Location, Facility Closure, Asset Sale, Lawsuit Filed. | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Event Type | `corporateStrategyNews[].eventType` | Granular event type (e.g., M&A, Facilities Expansion, Lawsuit Filed) | String | | Event Category | `corporateStrategyNews[].eventCategory` | Broad business grouping | String | | Event Summary | `corporateStrategyNews[].eventSummary` | A short, AI-generated summary of the event | String | | Event Effective Date | `corporateStrategyNews[].eventEffectiveDate` | The actual date the event took place (if known) | Date/Null | | Article Title | `corporateStrategyNews[].articleTitle` | The headline of the news source | String | | Article Sentence | `corporateStrategyNews[].articleSentence` | A specific quote/snippet from the news article | String | | Article URL | `corporateStrategyNews[].articleUrl` | Direct link to the source news article | URL | | Article Published Date | `corporateStrategyNews[].articlePublishedDate` | The date the article was published | Date | **Financial Events News Signal** Funding Round, Asset Investment, Strategic Investment, IPO. | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Event Type | `financialEventsNews[].eventType` | Granular event type (e.g., Funding Round, IPO) | String | | Event Category | `financialEventsNews[].eventCategory` | Broad business grouping | String | | Event Summary | `financialEventsNews[].eventSummary` | A short, AI-generated summary of the event | String | | Event Effective Date | `financialEventsNews[].eventEffectiveDate` | The actual date the event took place (if known) | Date/Null | | Article Title | `financialEventsNews[].articleTitle` | The headline of the news source | String | | Article Sentence | `financialEventsNews[].articleSentence` | A specific quote/snippet from the news article | String | | Article URL | `financialEventsNews[].articleUrl` | Direct link to the source news article | URL | | Article Published Date | `financialEventsNews[].articlePublishedDate` | The date the article was published | Date | **Market Intelligence News Signal** Event Participation, Recognition, Competitor Activity. | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Event Type | `marketIntelligenceNews[].eventType` | Granular event type (e.g., Event Participation, Recognition) | String | | Event Category | `marketIntelligenceNews[].eventCategory` | Broad business grouping | String | | Event Summary | `marketIntelligenceNews[].eventSummary` | A short, AI-generated summary of the event | String | | Event Effective Date | `marketIntelligenceNews[].eventEffectiveDate` | The actual date the event took place (if known) | Date/Null | | Article Title | `marketIntelligenceNews[].articleTitle` | The headline of the news source | String | | Article Sentence | `marketIntelligenceNews[].articleSentence` | A specific quote/snippet from the news article | String | | Article URL | `marketIntelligenceNews[].articleUrl` | Direct link to the source news article | URL | | Article Published Date | `marketIntelligenceNews[].articlePublishedDate` | The date the article was published | Date | **People News Signal** Executive Hire, Executive Departure, Executive Promotion, Headcount Increase, Headcount Decrease. | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Event Type | `peopleNews[].eventType` | Granular event type (e.g., Executive Hire, Headcount Increase) | String | | Event Category | `peopleNews[].eventCategory` | Broad business grouping | String | | Event Summary | `peopleNews[].eventSummary` | A short, AI-generated summary of the event | String | | Event Effective Date | `peopleNews[].eventEffectiveDate` | The actual date the event took place (if known) | Date/Null | | Article Title | `peopleNews[].articleTitle` | The headline of the news source | String | | Article Sentence | `peopleNews[].articleSentence` | A specific quote/snippet from the news article | String | | Article URL | `peopleNews[].articleUrl` | Direct link to the source news article | URL | | Article Published Date | `peopleNews[].articlePublishedDate` | The date the article was published | Date | **Product Activity News Signal** Product Launch, Product Development, Product Integration. | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Event Type | `productActivityNews[].eventType` | Granular event type (e.g., Product Launch, Product Development) | String | | Event Category | `productActivityNews[].eventCategory` | Broad business grouping | String | | Event Summary | `productActivityNews[].eventSummary` | A short, AI-generated summary of the event | String | | Event Effective Date | `productActivityNews[].eventEffectiveDate` | The actual date the event took place (if known) | Date/Null | | Article Title | `productActivityNews[].articleTitle` | The headline of the news source | String | | Article Sentence | `productActivityNews[].articleSentence` | A specific quote/snippet from the news article | String | | Article URL | `productActivityNews[].articleUrl` | Direct link to the source news article | URL | | Article Published Date | `productActivityNews[].articlePublishedDate` | The date the article was published | Date | **Risk News Signal** Security Issue, Lawsuit Faced. | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Event Type | `riskNews[].eventType` | Granular event type (e.g., Security Issue, Lawsuit Faced) | String | | Event Category | `riskNews[].eventCategory` | Broad business grouping | String | | Event Summary | `riskNews[].eventSummary` | A short, AI-generated summary of the event | String | | Event Effective Date | `riskNews[].eventEffectiveDate` | The actual date the event took place (if known) | Date/Null | | Article Title | `riskNews[].articleTitle` | The headline of the news source | String | | Article Sentence | `riskNews[].articleSentence` | A specific quote/snippet from the news article | String | | Article URL | `riskNews[].articleUrl` | Direct link to the source news article | URL | | Article Published Date | `riskNews[].articlePublishedDate` | The date the article was published | Date | details summary Lookalikes Returns companies similar to your reference companies based on firmographic attributes. **Inputs** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Company IDs | `companyIds` | Array of Lusha company IDs to use as reference | Array [Integer] | **Outputs** **Search Metadata** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Request ID | `requestId` | Unique session identifier for the lookalike request | String | | Count | `count` | Total number of similar companies returned, typically 25 | Integer | | Credits Charged | `creditsCharged` | Number of credits consumed for this search operation | Integer | **Company Details** | Field Name | API Path | Description | Data Type | | --- | --- | --- | --- | | Company ID | `companies[].companyId` | Lusha's unique global identifier for the organization | String | | Name | `companies[].name` | The full legal or common name of the organization | String | | FQDN | `companies[].fqdn` | Fully Qualified Domain Name, e.g. www.newsday.com | String | | Description | `companies[].description` | Textual overview of the company's business model and mission | String | ## Need help? - [**Full API Reference**](/apis/openapi) – Complete endpoint documentation with examples - [**Getting Started Guide**](/guides) – Learn how to authenticate and make your first request - [**Changelog**](/changelog) – Track new endpoints, parameter changes, deprecations - [**Q&A**](/qa) – FAQs and clarifications