--- updatedAt: 2026-04-24T07:17:22.000Z agentTools: projectIndex: https://apidocs.pearch.ai/llms.txt --- # Search companies and leads - Test this endpoint in the [playground](https://chat.pearch.ai/api-leads-search/new) - Check out official [Python client](https://github.com/Pearch-ai/pearch-client) Endpoint for finding companies and related leads within those companies. Primary use case is for B2B sales, but can also be used for headhunting/executive search. It uses natural language query and returns a list of most relevant companies. Allows for generation of personalized outreach messages for the identified leads. Main difference with [/v2/search](/reference/post_v2-search) is that the search starts with shortlisting relevant companies first, then finding leads who necessarily activaly work at these companies. Some recipes: - When you only need companies, pass only the company query: `{"company_query": "manufacturers of aviation parts"}` - When you need companies and leads, pass both company and lead queries. Note that the lead query shouldn't include company requirements: `{"company_query": "manufacturers of aviation parts", "lead_query": "CTOs and engineering managers"}` - When you want to generate personalized outreach messages for the identified leads, pass the outreach message instruction: `{"company_query": "manufacturers of aviation parts", "lead_query": "CTOs and engineering managers", "outreach_message_instruction": "Suggest buying my (Rob) SaaS recruitment product <300 characters, email style, casual, personal touch"}` - if you don't have good intuition about leads to target, use a very broad lead query like `{..., "lead_query": "people who I can contact regarding partnerships or any c-level (CEO CFO COO CTO CIO CMO CHRO CPO CLO CSO) /founder/director/owner roles"}` **Cost: (number of companies returned) × (5) + (number of leads returned) × (2 + sum of credits for `outreach_message_instruction`, `reveal_emails`, `reveal_phones`, `high_freshness`, plus 1 credit when `filter_out_no_emails` and `filter_out_no_phones` are both enabled)** _Check out official [Python client](https://github.com/Pearch-ai/pearch-client)_ CHECK HOW OUR CREDIT SYSTEM WORKS Insights and Research from PEARCH AI team # OpenAPI definition ````json { "openapi": "3.0.4", "info": { "title": "Pearch.AI API", "description": "Pearch.AI API. You need to pass API key as 'Authorization: Bearer ' header.", "version": "2.0" }, "x-readme": { "explorer-enabled": true, "samples-languages": [ "shell" ], "proxy-enabled": false }, "servers": [ { "url": "https://api.pearch.ai/", "description": "Main server" } ], "paths": { "/v2/search_company_leads": { "post": { "operationId": "post_v2-search-company-leads", "summary": "Search companies and leads", "tags": [ "Search" ], "description": "\n- Test this endpoint in the [playground](https://chat.pearch.ai/api-leads-search/new)\n- Check out official [Python client](https://github.com/Pearch-ai/pearch-client) \n\nEndpoint for finding companies and related leads within those companies. Primary use case is for B2B sales, but can also be used for headhunting/executive search. It uses natural language query and returns a list of most relevant companies. Allows for generation of personalized outreach messages for the identified leads. Main difference with [/v2/search](/reference/post_v2-search) is that the search starts with shortlisting relevant companies first, then finding leads who necessarily activaly work at these companies.\nSome recipes:\n- When you only need companies, pass only the company query: `{\"company_query\": \"manufacturers of aviation parts\"}`\n- When you need companies and leads, pass both company and lead queries. Note that the lead query shouldn't include company requirements: `{\"company_query\": \"manufacturers of aviation parts\", \"lead_query\": \"CTOs and engineering managers\"}`\n- When you want to generate personalized outreach messages for the identified leads, pass the outreach message instruction: `{\"company_query\": \"manufacturers of aviation parts\", \"lead_query\": \"CTOs and engineering managers\", \"outreach_message_instruction\": \"Suggest buying my (Rob) SaaS recruitment product <300 characters, email style, casual, personal touch\"}`\n- if you don't have good intuition about leads to target, use a very broad lead query like `{..., \"lead_query\": \"people who I can contact regarding partnerships or any c-level (CEO CFO COO CTO CIO CMO CHRO CPO CLO CSO) /founder/director/owner roles\"}`\n\n**Cost: (number of companies returned) × (5) + (number of leads returned) × (2 + sum of credits for `outreach_message_instruction`, `reveal_emails`, `reveal_phones`, `high_freshness`, plus 1 credit when `filter_out_no_emails` and `filter_out_no_phones` are both enabled)**\n\n_Check out official [Python client](https://github.com/Pearch-ai/pearch-client)_\n", "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "company_query": { "type": "string", "description": "The search query for finding companies. **Cost: 5 credits per company**", "example": "AI startups in San Francisco with 50-200 employees", "default": "AI startups in San Francisco with 50-200 employees" }, "thread_id": { "type": "string", "description": "Unique identifier returned by every `/v2/search_company_leads` call. Reuse it only to paginate the existing result set. Search parameters must not be supplied with `thread_id`; doing so returns HTTP 400. You are charged only for additional results. Running a search with the same `thread_id` and same `limit` returns the same results without additional charges.", "example": "ec191bf9-99ff-4989-8383-c97c71fafb6d" }, "lead_query": { "type": "string", "description": "Optional query for finding specific leads within the companies. Do not include company requirements in the lead query. if you don't have good intuition about personas to target, use a very broad query like `{..., \"lead_query\": \"people who I can contact regarding partnerships or any c-level (CEO CFO COO CTO CIO CMO CHRO CPO CLO CSO) /founder/director/owner roles\"}` **Cost: 2 credits per lead**", "example": "CTOs and engineering managers" }, "outreach_message_instruction": { "type": "string", "description": "Optional instruction for generating personalized outreach messages. This uses LLM to generate a message for each lead. In addition to this instruction the LLM gets full lead's profile and company information as context. **Cost: 3 credits per lead**", "example": "Suggest buying my saas recruitment product <300 characters, email style, casual" }, "limit": { "type": "integer", "minimum": 1, "maximum": 1000, "default": 50, "description": "The maximum number of company results to return." }, "leads_limit": { "type": "integer", "minimum": 1, "maximum": 10, "default": 3, "description": "The number of leads to find per company." }, "reveal_emails": { "type": "boolean", "default": false, "description": "Include email addresses in lead results if available. **Cost: 3 credits per lead**. Deprecated name: `show_emails`" }, "reveal_phones": { "type": "boolean", "default": false, "description": "Include phone numbers in lead results if available. **Cost: 8 credits per lead**. Deprecated name: `show_phone_numbers`" }, "filter_out_no_emails": { "type": "boolean", "default": false, "description": "Only return leads with at least one email address. Leads will have an additional `has_email` field set to true. **Combined cost: 1 credit per returned lead when both `filter_out_no_emails` and `filter_out_no_phones` are enabled.** Deprecated name: `require_emails`" }, "filter_out_no_phones": { "type": "boolean", "default": false, "description": "Only return leads with at least one phone number. Leads will have an additional `has_phone_numbers` field set to true. **Combined cost: 1 credit per returned lead when both `filter_out_no_emails` and `filter_out_no_phones` are enabled.** Deprecated name: `require_phone_numbers`" }, "high_freshness": { "type": "boolean", "default": false, "description": "Enable real-time profile updates for fresher lead data. This downloads the most recent copies of profiles directly from source websites in realtime (e.g. Linkedin). If you are ok with profiles that may be a few months outdated, and want to save ~30 seconds, turn off high_freshness. Refreshed roles include `employment_type` when the source provides it. **Cost: 1 credit per lead**" }, "company_high_freshness": { "type": "boolean", "default": false, "description": "Enable real-time company data updates for fresher company information. This looks up companies on the internet in realtime and is included in the company search cost." } }, "required": [ "company_query" ] } } } }, "responses": { "200": { "description": "Company and lead search completed", "content": { "application/json": { "schema": { "type": "object", "properties": { "uuid": { "type": "string", "description": "Unique identifier for this search request.", "example": "f47ac10b-58cc-4372-a567-0e02b2c3d479" }, "thread_id": { "type": "string", "description": "Thread identifier that can be used to paginate the existing result set.", "example": "ec191bf9-99ff-4989-8383-c97c71fafb6d" }, "query": { "type": "string", "description": "The complete search query that was processed.", "example": "Find companies: ```AI startups in San Francisco```\nFind leads in these companies: ```CTOs and engineering managers```" }, "search_results": { "type": "array", "description": "List of company search results with associated leads.", "items": { "$ref": "#/components/schemas/CompanyLeadResult" } }, "created_at": { "type": "number", "format": "float", "description": "Timestamp (UNIX epoch) when the query was created.", "example": 1744446727.123 }, "duration": { "type": "number", "format": "float", "description": "Time taken to complete the search in seconds.", "example": 3.21 }, "user": { "type": "string", "description": "Email address of the user who made the query.", "example": "dev@dev.co" }, "status": { "type": "string", "description": "The current status of the query. One of `pending`, `Done`, `failed`.", "example": "Done" }, "total_estimate": { "type": "integer", "description": "The estimated total number of companies available.", "example": 500 }, "total_estimate_is_lower_bound": { "type": "boolean", "description": "Indicates whether the total_estimate is a lower bound. If true, there may be more companies available than the estimate suggests.", "example": false }, "credits_remaining": { "type": "integer", "description": "Number of credits remaining for the user.", "example": 950 }, "parameters": { "type": "object", "description": "All input parameters that were sent with the request.", "additionalProperties": true, "example": { "company_query": "AI startups in San Francisco", "lead_query": "CTOs and engineering managers", "limit": 50, "leads_limit": 3 } } } } } } }, "400": { "description": "Invalid parameter values. JSON body contains the error message." }, "401": { "description": "Invalid API key" }, "502": { "description": "Search Backend Error" } } } } }, "components": { "schemas": { "Language": { "type": "object", "description": "Language with proficiency level", "properties": { "language": { "type": "string", "description": "Language name", "example": "English" }, "proficiency": { "type": "string", "description": "Proficiency level: A1, A2, B1, B2, C1, C2", "enum": [ "A1", "A2", "B1", "B2", "C1", "C2", "unknown" ], "example": "C1" } } }, "FundingRound": { "type": "object", "description": "Information about a company's funding round", "properties": { "value_usd": { "type": "integer", "description": "Funding amount in USD", "example": 2000000 }, "date": { "type": "string", "format": "date", "description": "Date of the funding round", "example": "2023-06-15" }, "round_name": { "type": "string", "description": "Name of the funding round", "example": "Series A" } } }, "CompanyInfo": { "type": "object", "description": "Comprehensive company information and metadata", "properties": { "name": { "type": "string", "description": "The name of the company", "example": "Dragoonitcn" }, "domain": { "type": "string", "description": "Company's primary domain", "example": "dragoonitcn.com" }, "website": { "type": "string", "description": "The official website of the company", "example": "http://www.dragoonitcn.com" }, "linkedin_url": { "type": "string", "description": "The LinkedIn URL of the company", "example": "https://linkedin.com/company/dragoon-itcn" }, "linkedin_slug": { "type": "string", "description": "LinkedIn slug identifier", "example": "dragoon-itcn" }, "crunchbase_url": { "type": "string", "description": "The Crunchbase URL of the company", "example": "https://www.crunchbase.com/organization/dragoonitcn" }, "social_urls": { "type": "array", "description": "List of social media URLs", "items": { "type": "string" }, "example": [ "https://twitter.com/dragoonitcn", "https://facebook.com/pages/Dragoonitcn/125328487521849" ] }, "emails": { "type": "array", "description": "List of company email addresses", "items": { "type": "string" }, "example": [ "contact@dragoonitcn.com", "sales@dragoonitcn.com" ] }, "phone_number": { "type": "string", "description": "Company phone number", "example": "+1-555-123-4567" }, "phone_numbers": { "type": "array", "description": "List of company phone numbers", "items": { "type": "string" }, "example": [ "+1-555-123-4567", "+1-555-987-6543" ] }, "short_address": { "type": "string", "description": "Brief address information", "example": "Dayton, OH" }, "locations": { "type": "array", "description": "List of company locations", "items": { "type": "string" }, "example": [ "Dayton, Ohio", "San Francisco, CA" ] }, "type": { "type": "string", "description": "Type of company", "example": "Private" }, "description": { "type": "string", "description": "A brief description of the company's business", "example": "Targeting Complex Aerospace Issues with Precision Test Tools" }, "industries": { "type": "array", "description": "The industries the company operates in", "items": { "type": "string", "enum": [ "Archiving Service", "Call Center", "Collection Agency", "College Recruiting", "Courier Service", "Debt Collections", "Delivery", "Document Preparation", "Employee Benefits", "Extermination Service", "Facilities Support Services", "Housekeeping Service", "Human Resources", "Knowledge Management", "Office Administration", "Packaging Services", "Physical Security", "Project Management", "Staffing Agency", "Trade Shows", "Virtual Workforce", "Ad Exchange", "Ad Network", "Ad Retargeting", "Ad Server", "Ad Targeting", "Advertising", "Advertising Platforms", "Affiliate Marketing", "Local Advertising", "Mobile Advertising", "Native Advertising", "Outdoor Advertising", "SEM", "Social Media Advertising", "Video Advertising", "Agriculture", "AgTech", "Animal Feed", "Aquaculture", "Equestrian", "Farming", "Forestry", "Horticulture", "Hydroponics", "Livestock", "App Discovery", "Apps", "Consumer Applications", "Enterprise Applications", "Mobile Apps", "Reading Apps", "Web Apps", "Artificial Intelligence (AI)", "Generative AI", "Intelligent Systems", "Machine Learning", "Natural Language Processing", "Predictive Analytics", "Robotic Process Automation (RPA)", "Bioinformatics", "Biometrics", "Biopharma", "Biotechnology", "Genetics", "Life Science", "Neuroscience", "Quantified Self", "Bitcoin", "Blockchain", "Cryptocurrency", "Decentralized Finance (DeFi)", "Ethereum", "Non-Fungible Token (NFT)", "Smart Contracts", "Web3", "Apparel", "Fashion", "Laundry and Dry-cleaning", "Lingerie", "Shoes", "Auctions", "Classifieds", "Collectibles", "Consumer Reviews", "Coupons", "E-Commerce", "E-Commerce Platforms", "Flash Sale", "Gift", "Gift Card", "Gift Exchange", "Gift Registry", "Group Buying", "Local Shopping", "Made to Order", "Marketplace", "Office Supplies", "Online Auctions", "Personalization", "Point of Sale", "Price Comparison", "Rental", "Retail", "Retail Technology", "Secondhand Goods", "Shopping", "Shopping Mall", "Social Shopping", "Sporting Goods", "Vending and Concessions", "Virtual Goods", "Wholesale", "Adult", "Baby", "Cannabis", "Children", "Communities", "Dating", "Elderly", "Family", "Funerals", "Humanitarian", "Leisure", "LGBT", "Lifestyle", "Men's", "Online Forums", "Parenting", "Pet", "Private Social Networking", "Professional Networking", "Q&A", "Religion", "Retirement", "Sex Industry", "Sex Tech", "Social", "Social Entrepreneurship", "Teenagers", "Virtual World", "Wedding", "Women's", "Young Adults", "Computer", "Consumer Electronics", "Drones", "Electronics", "Google Glass", "Mobile Devices", "Nintendo", "Playstation", "Roku", "Smart Home", "Wearables", "Windows Phone", "Xbox", "Beauty", "Card and Board Games", "Cleaning Products", "Comics", "Consumer Goods", "Cosmetics", "DIY", "Eyewear", "Fast-Moving Consumer Goods", "Flowers", "Furniture", "Green Consumer Goods", "Handmade", "Home Appliances", "Jewelry", "Personal Care and Hygiene", "Tobacco", "Toys", "Blogging Platforms", "Books", "Content Delivery Network", "Content Discovery", "Content Syndication", "Copywriting", "Creative Agency", "DRM", "EBooks", "Journalism", "News", "Photo Editing", "Photo Sharing", "Photography", "Printing", "Publishing", "Social Bookmarking", "Video Editing", "Video Streaming", "A/B Testing", "Analytics", "Application Performance Management", "Big Data", "Business Intelligence", "Consumer Research", "Data Collection and Labeling", "Data Governance", "Data Integration", "Data Management", "Data Mining", "Data Visualization", "Database", "Facial Recognition", "Geospatial", "Image Recognition", "Location Based Services", "Market Research", "Product Research", "Speech Recognition", "Test and Measurement", "Text Analytics", "Usability Testing", "CAD", "Graphic Design", "Human Computer Interaction", "Industrial Design", "Interior Design", "Mechanical Design", "Product Design", "UX Design", "Web Design", "Alumni", "Charter Schools", "Continuing Education", "Corporate Training", "E-Learning", "EdTech", "Education", "Edutainment", "Higher Education", "Language Learning", "MOOC", "Music Education", "Personal Development", "Primary Education", "Secondary Education", "Skill Assessment", "Special Education", "STEM Education", "Textbook", "Training", "Tutoring", "Vocational Education", "Battery", "Biofuel", "Biomass Energy", "Clean Energy", "Electrical Distribution", "Energy", "Energy Efficiency", "Energy Management", "Energy Storage", "Fossil Fuels", "Fuel", "Fuel Cell", "Geothermal Energy", "Hydroelectric", "Oil and Gas", "Power Grid", "Renewable Energy", "Solar", "Wind Energy", "Concerts", "Event Management", "Event Promotion", "Events", "Nightclubs", "Nightlife", "Reservations", "Ticketing", "Accounting", "Angel Investment", "Asset Management", "Auto Insurance", "Banking", "Bookkeeping and Payroll", "Commercial Insurance", "Commercial Lending", "Consumer Lending", "Credit", "Credit Bureau", "Credit Cards", "Crowdfunding", "Debit Cards", "Finance", "Financial Exchanges", "Financial Services", "FinTech", "Foreign Exchange Trading", "Fraud Detection", "Funding Platform", "Health Insurance", "Hedge Funds", "Impact Investing", "Incubators", "Insurance", "InsurTech", "Leasing", "Lending", "Life Insurance", "Micro Lending", "Mobile Payments", "Payments", "Personal Finance", "Prediction Markets", "Prepaid Cards", "Property Insurance", "Real Estate Investment", "Stock Exchanges", "Tax Consulting", "Tax Preparation", "Trading Platform", "Transaction Processing", "Venture Capital", "Virtual Currency", "Wealth Management", "Alternative Protein", "Bakery", "Brewing", "Catering", "Coffee", "Confectionery", "Cooking", "Craft Beer", "Dairy", "Dietary Supplements", "Distillery", "Farmers Market", "Food and Beverage", "Food Delivery", "Food Processing", "Food Trucks", "Fruit", "Grocery", "Herbs and Spices", "Meat and Poultry", "Nutrition", "Organic Food", "Plant-Based Foods", "Recipes", "Restaurants", "Seafood", "Snack Food", "Tea", "Wine And Spirits", "Winery", "Casual Games", "Console Games", "Contests", "Fantasy Sports", "Gambling", "Gamification", "Gaming", "MMO Games", "Online Games", "PC Games", "Serious Games", "Video Games", "CivicTech", "Government", "GovTech", "Law Enforcement", "Military", "National Security", "Politics", "Public Safety", "Social Assistance", "3D Technology", "Application Specific Integrated Circuit (ASIC)", "Audio/Visual Equipment", "Augmented Reality", "Cloud Infrastructure", "Communication Hardware", "Communications Infrastructure", "Computer Vision", "Data Center", "Data Center Automation", "Data Storage", "Drone Management", "DSP", "Electronic Design Automation (EDA)", "Embedded Systems", "Field-Programmable Gate Array (FPGA)", "Flash Storage", "GPS", "GPU", "Hardware", "Laser", "Lighting", "Network Hardware", "NFC", "Optical Communication", "Private Cloud", "Remote Sensing", "RFID", "RISC", "Robotics", "Satellite Communication", "Semiconductor", "Sensor", "Telecommunications", "Video Conferencing", "Virtual Reality", "Virtualization", "Wireless", "Addiction Treatment", "Alternative Medicine", "Assisted Living", "Assistive Technology", "Child Care", "Clinical Trials", "Cosmetic Surgery", "Dental", "Diabetes", "Elder Care", "Electronic Health Record (EHR)", "Emergency Medicine", "Fertility", "First Aid", "Health Care", "Health Diagnostics", "Home Health Care", "Hospital", "Medical", "Medical Device", "Mental Health", "mHealth", "Nursing and Residential Care", "Nutraceutical", "Oncology", "Outpatient Care", "Personal Health", "Pharmaceutical", "Precision Medicine", "Primary and Urgent Care", "Psychology", "Rehabilitation", "Telehealth", "Therapeutics", "Veterinary", "Wellness", "Business Information Systems", "Cloud Data Services", "Cloud Management", "Cloud Security", "CMS", "Contact Management", "CRM", "Cyber Security", "DevOps", "Document Management", "E-Signature", "Email", "Identity Management", "Information and Communications Technology (ICT)", "Information Services", "Information Technology", "Intrusion Detection", "IT Infrastructure", "IT Management", "Management Information Systems", "Messaging", "Network Security", "Penetration Testing", "Reputation", "Sales Automation", "Scheduling", "Social CRM", "Spam Filtering", "Technical Support", "Unified Communications", "Video Chat", "VoIP", "Cloud Computing", "Cloud Storage", "Darknet", "Domain Registrar", "Ediscovery", "Internet", "Internet of Things", "ISP", "Music Streaming", "Online Portals", "Product Search", "Search Engine", "Semantic Search", "Semantic Web", "SEO", "SMS", "Social Media", "Social Media Management", "Social Network", "Vertical Search", "Visual Search", "Web Browsers", "Web Hosting", "3D Printing", "Advanced Materials", "Foundries", "Industrial", "Industrial Automation", "Industrial Engineering", "Industrial Manufacturing", "Machinery Manufacturing", "Manufacturing", "Paper Manufacturing", "Plastics and Rubber Manufacturing", "Textiles", "Wood Processing", "Advice", "Animation", "Art", "Audio", "Audiobooks", "Broadcasting", "Celebrity", "Content", "Content Creators", "Digital Entertainment", "Digital Media", "Film", "Film Distribution", "Film Production", "Guides", "In-Flight Entertainment", "Independent Music", "Internet Radio", "Media and Entertainment", "Metaverse", "Motion Capture", "Music", "Music Label", "Music Venues", "Musical Instruments", "Performing Arts", "Podcast", "Social News", "Theatre", "TV", "TV Production", "Video", "Video on Demand", "Meeting Software", "Wired Telecommunications", "Android", "iOS", "Mobile", "Audio Recording and Production", "Mineral", "Mining", "Mining Technology", "Natural Resources", "Precious Metals", "Timber", "Water", "Indoor Positioning", "Mapping Services", "Navigation", "Association", "B2B", "B2C", "Charity", "Collaboration", "Collaborative Consumption", "Commercial", "Consumer", "Crowdsourcing", "Customer Service", "Desktop Apps", "Emerging Markets", "Enterprise", "Franchise", "Freemium", "Generation Y", "Generation Z", "Homeless Shelter", "Infrastructure", "LGBT Millennials", "Non Profit", "Peer to Peer", "Professional Services", "Real Time", "Service Industry", "Sharing Economy", "Small and Medium Businesses", "Social Impact", "Subscription Service", "Underserved Children", "Universities", "Billing", "Facebook", "Google", "Linux", "macOS", "Operating Systems", "Tizen", "Twitter", "WebOS", "Windows", "Corrections Facilities", "Homeland Security", "Privacy", "Security", "Advocacy", "Business Development", "Career Planning", "Compliance", "Consulting", "Employment", "Environmental Consulting", "Field Support", "Freelance", "Innovation Management", "Intellectual Property", "Legal", "Legal Tech", "Management Consulting", "Outsourcing", "Quality Assurance", "Recruiting", "Risk Management", "Social Recruiting", "Translation Service", "Architecture", "Building Maintenance", "Building Material", "Commercial Real Estate", "Construction", "Coworking", "Facility Management", "Green Building", "Heating", "Ventilation", "and Air Conditioning (HVAC)", "Home and Garden", "Home Decor", "Home Improvement", "Home Renovation", "Home Services", "Janitorial Service", "Landscaping", "Mortgage", "Property Development", "Property Management", "PropTech", "Real Estate", "Real Estate Brokerage", "Rental Property", "Residential", "Self-Storage", "Smart Building", "Smart Cities", "Timeshare", "Vacation Rental", "App Marketing", "Brand Marketing", "Cause Marketing", "Content Marketing", "Digital Marketing", "Digital Signage", "Direct Marketing", "Direct Sales", "Email Marketing", "Lead Generation", "Lead Management", "Local", "Local Business", "Loyalty Programs", "Marketing", "Marketing Automation", "Multi-level Marketing", "Personal Branding", "Public Relations", "Sales", "Sales Enablement", "Social Media Marketing", "Sponsorship", "Aerospace", "Chemical", "Chemical Engineering", "Civil Engineering", "Environmental Engineering", "Marine Technology", "Mechanical Engineering", "Nanotechnology", "Nuclear", "Quantum Computing", "Software Engineering", "Browser Extensions", "Business Process Automation (BPA)", "Chatbot", "Consumer Software", "Developer APIs", "Developer Platform", "Developer Tools", "Embedded Software", "Enterprise Resource Planning (ERP)", "Enterprise Software", "File Sharing", "IaaS", "Open Source", "PaaS", "Presentation Software", "Presentations", "Productivity Tools", "QR Codes", "SaaS", "Simulation", "SNS", "Software", "Task Management", "Virtual Assistant", "Virtual Desktop", "Web Development", "American Football", "Baseball", "Basketball", "Boating", "Cricket", "Cycling", "Diving", "eSports", "Fitness", "Golf", "Hockey", "Hunting", "Motorsports", "Outdoors", "Racing", "Recreation", "Rugby", "Sailing", "Skiing", "Soccer", "Sports", "Sports Leagues and Teams", "Surfing", "Swimming", "Table Tennis", "Tennis", "Ultimate Frisbee", "Volley Ball", "Carbon Capture", "CleanTech", "GreenTech", "Organic", "Pollution Control", "Recycling", "Sustainability", "Waste Management", "Water Purification", "Wildlife Conservation", "Air Transportation", "Automotive", "Autonomous Vehicles", "Car Sharing", "Charging Infrastructure", "Delivery Service", "Electric Vehicle", "Ferry Service", "Fleet Management", "Freight Service", "Last Mile Transportation", "Limousine Service", "Logistics", "Marine Transportation", "Parking", "Ports and Harbors", "Procurement", "Public Transportation", "Railroad", "Recreational Vehicles", "Ride Sharing", "Same Day Delivery", "Shipping", "Shipping Broker", "Space Travel", "Supply Chain Management", "Taxi Service", "Transportation", "Warehouse Automation", "Warehousing", "Water Transportation", "Adventure Travel", "Amusement Park and Arcade", "Business Travel", "Casino", "Hospitality", "Hotel", "Museums and Historical Sites", "Parks", "Resorts", "Tour Operator", "Tourism", "Travel", "Travel Accommodations", "Travel Agency", "Administrative", "Apparel & Fashion", "Arts", "Associations", "Automation", "Aviation", "Beverage Manufacturing", "Broadcast Media", "Business", "Business Supplies and Equipment", "Computer Hardware", "Computer Networking", "Computer Software", "Consumer Services", "Defense", "Design", "Digital Accessibility", "Education Management", "Electric Power", "Electrical/Electronic Manufacturing", "Emergency", "Engineering", "Entertainment", "Events Services", "Facilities", "Food Production", "IT Services", "Import/Export", "International Affairs", "International Trade and Development", "Investment Management", "Judiciary", "Legal Services", "Libraries", "Machinery", "Maintenance", "Mapping", "Maritime", "Media", "Media Production", "Motion Pictures and Film", "Networking", "Non-profit Organizations", "Outsourcing/Offshoring", "Personal Care", "Pharmaceuticals", "Philanthropy", "Postal", "Professional Training", "Professional Training & Coaching", "Program Management", "Public Policy", "Religious Institutions", "Repair and Maintenance", "Research", "Safety", "Services", "Shipbuilding", "Social Services", "Software Development", "Staffing", "Think Tanks", "Trade", "Translation", "Urban Planning", "Utilities", "Venture Capital & Private Equity", "Vocational", "Women's Handbag Manufacturing", "Writing" ] }, "example": [ "Aerospace", "GreenTech", "Information Technology" ] }, "specialties": { "type": "array", "description": "Company specialties", "items": { "type": "string" }, "example": [ "Precision Testing", "Aerospace Solutions" ] }, "keywords": { "type": "array", "description": "Keywords associated with the company's operations", "items": { "type": "string" }, "example": [ "cable fault isolation", "tdr", "comint" ] }, "technologies": { "type": "array", "description": "Technologies used by the company", "items": { "type": "string" }, "example": [ "Python", "Machine Learning", "Cloud Computing" ] }, "founded_in": { "type": "integer", "description": "The year the company was founded", "example": 1992 }, "num_employees": { "type": "integer", "description": "Exact number of employees", "example": 25 }, "num_employees_range": { "type": "string", "description": "The range of the number of employees in the company", "example": "11-50" }, "annual_revenue": { "type": "integer", "description": "The annual revenue of the company in USD", "example": 33867000 }, "followers_count": { "type": "integer", "description": "Number of followers on LinkedIn", "example": 1500 }, "funding_total_usd": { "type": "integer", "description": "Total funding raised in USD", "example": 5000000 }, "latest_funding_amount": { "type": "integer", "description": "Amount of the latest funding round in USD", "example": 2000000 }, "latest_funding_round": { "type": "string", "description": "Latest funding round information", "example": "Series A" }, "last_funding_round_year": { "type": "integer", "description": "Year of the last funding round", "example": 2023 }, "last_funding_round_date": { "type": "string", "format": "date", "description": "Exact date of the latest funding round", "example": "2023-09-15" }, "valuation": { "type": "integer", "description": "Company valuation in USD", "example": 50000000 }, "funding_rounds": { "type": "array", "description": "List of funding rounds", "items": { "$ref": "#/components/schemas/FundingRound" } }, "ipo_date": { "type": "string", "format": "date", "description": "Date when the company went public", "example": "2021-04-14" }, "has_ipo": { "type": "boolean", "description": "Indicates if the company has had an Initial Public Offering (IPO)", "example": false }, "is_b2b": { "type": "boolean", "description": "Indicates if the company operates on a Business-to-Business model", "example": true }, "is_b2c": { "type": "boolean", "description": "Indicates if the company operates on a Business-to-Consumer model", "example": false }, "is_saas": { "type": "boolean", "description": "Indicates if the company provides Software as a Service", "example": false }, "is_health_tech": { "type": "boolean", "description": "Indicates if the company operates in health technology", "example": false }, "is_hiring": { "type": "boolean", "description": "Indicates if the company is currently hiring", "example": true }, "backed_by_y_combinator": { "type": "boolean", "description": "Indicates if the company is backed by Y Combinator", "example": false }, "icon": { "type": "string", "description": "The URL to the company's icon image", "example": "https://zenprospect-production.s3.amazonaws.com/uploads/pictures/6768a72faa352b0001ee57ef/picture" }, "website_score": { "type": "integer", "description": "Website quality/trust score", "example": 85 } } }, "Experience": { "type": "object", "description": "Professional work experience", "properties": { "sequenceNo": { "type": "integer", "description": "Sequence number for ordering roles", "example": 1 }, "company": { "type": "string", "description": "Name of the company for this role", "example": "Dragoonitcn" }, "company_domain": { "type": "string", "description": "Company domain", "example": "dragoonitcn.com" }, "title": { "type": "string", "description": "Job title for the role", "example": "Software Engineer II" }, "employment_type": { "type": "string", "nullable": true, "description": "Employment type supplied by the profile source, such as Full-time, Part-time, Contract, Freelance, or Self-employed. With high_freshness=true, refreshed profiles include this field when the source provides it. It may be absent or null when unavailable, including in older indexed profiles.", "example": "Contract" }, "start_date": { "type": "string", "format": "date", "description": "Start date of the role", "example": "2024-01-01" }, "end_date": { "type": "string", "format": "date", "description": "End date of the role", "example": "2024-08-01" }, "duration_years": { "type": "number", "description": "Duration in years the role was held", "example": 0.7 }, "age_years": { "type": "number", "description": "How long ago has the candidate left the role (in years). So essentially it's today - end_date in years.", "example": 1.2 }, "location": { "type": "string", "description": "Location of the job", "example": "Dayton, Ohio, United States" }, "location_info": { "type": "object", "description": "Structured location information, including latitude, longitude, and country code", "properties": { "lat": { "type": "number", "format": "float", "description": "Latitude of the location", "example": 37.7749 }, "lng": { "type": "number", "format": "float", "description": "Longitude of the location", "example": -122.4194 }, "country_code": { "type": "string", "description": "ISO 3166-1 alpha-2 country code (e.g., \"US\", \"IN\")", "example": "US" } }, "additionalProperties": false }, "experience_summary": { "type": "string", "description": "Summary of responsibilities and accomplishments in this role", "example": "Designed and developed software using .NET..." }, "is_current_experience": { "type": "boolean", "description": "Whether this is the current role", "example": true }, "is_startup_experience": { "type": "boolean", "description": "Whether this role overlapped the funded company's first seven years", "example": true } } }, "Education": { "type": "object", "description": "Educational experience", "properties": { "sequenceNo": { "type": "integer", "description": "Sequence number for ordering education entries", "example": 1 }, "university_linkedin_url": { "type": "string", "description": "LinkedIn URL of the educational institution", "example": "https://linkedin.com/school/university-of-california-berkeley" }, "campus": { "type": "string", "description": "Campus name or location", "example": "Berkeley Campus" }, "specialization": { "type": "string", "description": "Field of specialization or study", "example": "Computer Science" }, "specialization_category": { "type": "string", "description": "Category of specialization or study", "example": "Computer Science & IT", "enum": [ "Business & Management", "Finance", "Engineering", "Computer Science & IT", "Health & Medicine", "Social Sciences", "Natural Sciences", "Mathematics", "Education", "Communication & Media", "Arts, Design & Architecture", "Humanities & Liberal Arts", "Law & Criminal Justice" ] }, "degree": { "type": "array", "description": "List of degrees obtained: \"bachelor\", \"master\", \"MBA\", \"doctor\", \"postdoc\"", "items": { "type": "string", "enum": [ "bachelor", "master", "MBA", "doctor", "postdoc" ] }, "example": [ "bachelor", "doctor" ] }, "major": { "type": "string", "description": "Major field of study", "example": "Computer Science" }, "start_date": { "type": "string", "format": "date", "description": "Start date of the education", "example": "2018-09-01" }, "end_date": { "type": "string", "format": "date", "description": "End date of the education", "example": "2022-06-01" } } }, "Certification": { "type": "object", "description": "Professional certification", "properties": { "title": { "type": "string", "description": "Certification title", "example": "AWS Certified Solutions Architect" } } }, "Patent": { "type": "object", "description": "Patent information", "properties": { "title": { "type": "string", "description": "Patent title", "example": "Machine Learning Algorithm for Data Processing" }, "reference": { "type": "string", "description": "Patent reference number", "example": "US10123456B2" }, "description": { "type": "string", "description": "Patent description", "example": "A novel approach to processing large datasets using machine learning techniques" }, "date": { "type": "string", "format": "date", "description": "Patent date", "example": "2023-05-15" }, "url": { "type": "string", "description": "URL to patent documentation", "example": "https://patents.uspto.gov/patent/10123456" } } }, "CompanyExperienceGroup": { "type": "object", "description": "Group of experiences at the same company", "properties": { "company_info": { "$ref": "#/components/schemas/CompanyInfo" }, "company_roles": { "type": "array", "description": "Roles held by the candidate in this company", "items": { "$ref": "#/components/schemas/Experience" } } } }, "Profile": { "type": "object", "description": "Structured profile of the candidate based on StrictProfile schema.", "properties": { "docid": { "type": "string", "description": "Unique document ID of the candidate profile.", "example": "jason-tysl" }, "linkedin_slug": { "type": "string", "description": "LinkedIn profile slug/identifier. This is the part that comes after `https://www.linkedin.com/in/` in the profile URL. Because index freshness varies, the slug may not always resolve to a publicly visible profile. If fully up-to-date data is critical, enable the high_freshness parameter.", "example": "jason-tysl" }, "first_name": { "type": "string", "description": "First name of the candidate.", "example": "Jason" }, "middle_name": { "type": "string", "description": "Middle name of the candidate.", "example": "Michael" }, "last_name": { "type": "string", "description": "Last name of the candidate.", "example": "Tysl" }, "picture_url": { "type": "string", "description": "URL to the candidate's profile picture.", "example": "https://example.com/profile.jpg" }, "title": { "type": "string", "description": "Current job title or headline.", "example": "Software Engineer II" }, "summary": { "type": "string", "description": "Professional summary or bio.", "example": "Experienced software engineer with expertise in..." }, "gender": { "type": "string", "description": "Gender of the candidate. As of now only two genders are supported: male, female", "enum": [ "male", "female" ], "example": "male" }, "is_decision_maker": { "type": "number", "description": "Whether the candidate is a decision maker in their organization 0 means no, 1 means yes.", "example": 1 }, "languages": { "type": "array", "description": "List of languages the candidate knows with proficiency levels.", "items": { "$ref": "#/components/schemas/Language" } }, "inferred_languages": { "type": "array", "description": "Languages inferred from the candidate's profile with proficiency levels.", "items": { "$ref": "#/components/schemas/Language" } }, "location": { "type": "string", "description": "Current location of the candidate.", "example": "Bristol, England, United Kingdom" }, "location_coordinates": { "type": "object", "description": "Coordinates of the candidate's current location, when available.", "properties": { "lng": { "type": "number", "format": "double", "example": -2.6 }, "lat": { "type": "number", "format": "double", "example": 51.5 }, "country_code": { "type": "string", "description": "Country code associated with the coordinates, when available.", "example": "GB" } } }, "location_country_code": { "type": "string", "description": "ISO 3166-1 alpha-2 country code of the candidate's current location.", "example": "GB" }, "location_regions": { "type": "array", "description": "Geographic regions associated with the candidate's current location.", "items": { "type": "string" }, "example": [ "Europe", "EMEA" ] }, "is_top_universities": { "type": "boolean", "description": "Whether the candidate attended a top university.", "example": true }, "is_opentowork": { "type": "boolean", "description": "Whether the candidate is open to work opportunities. Only when realtime profiles are enabled. This field is only available for profiles that opened their \"open to work\" status publicly.", "example": false }, "is_hiring": { "type": "boolean", "description": "Whether the candidate is currently hiring. Only when realtime profiles are enabled.", "example": false }, "total_experience_years": { "type": "number", "description": "Total years of professional experience.", "example": 3.5 }, "estimated_age": { "type": "number", "description": "Estimated age of the candidate.", "example": 28 }, "expertise": { "type": "array", "description": "Areas of expertise or skills.", "items": { "type": "string" }, "example": [ "Python", "Machine Learning", "Software Engineering" ] }, "has_emails": { "type": "boolean", "description": "Whether the candidate has any email addresses available.", "example": true }, "emails": { "type": "array", "description": "List of all email addresses associated with the candidate.", "items": { "type": "string" }, "example": [ "jtysl@agileblue.com", "jason.tysl@gmail.com" ] }, "best_personal_email": { "type": "string", "description": "Best personal email address for the candidate.", "example": "jason.tysl@gmail.com" }, "best_business_email": { "type": "string", "description": "Best business email address for the candidate.", "example": "jtysl@agileblue.com" }, "personal_emails": { "type": "array", "description": "List of personal email addresses.", "items": { "type": "string" }, "example": [ "jason.tysl@gmail.com" ] }, "business_emails": { "type": "array", "description": "List of business email addresses.", "items": { "type": "string" }, "example": [ "jtysl@agileblue.com" ] }, "has_phone_numbers": { "type": "boolean", "description": "Whether the candidate has any phone numbers available.", "example": true }, "phone_numbers": { "type": "array", "description": "List of phone numbers associated with the candidate.", "items": { "type": "string" }, "example": [ "+1-555-123-4567" ] }, "phone_types": { "type": "array", "description": "List of phone number types available for the candidate.", "items": { "type": "string", "enum": [ "mobile" ] }, "example": [ "mobile" ] }, "websites": { "type": "array", "description": "List of social profile URLs found during phone or email enrichment.", "items": { "type": "string" }, "example": [ "https://twitter.com/johndoe", "https://github.com/johndoe" ] }, "followers_count": { "type": "integer", "description": "Number of followers on LinkedIn.", "example": 150 }, "connections_count": { "type": "integer", "description": "Number of connections on LinkedIn.", "example": 500 }, "experiences": { "type": "array", "description": "List of professional work experiences grouped by company.", "items": { "$ref": "#/components/schemas/CompanyExperienceGroup" } }, "educations": { "type": "array", "description": "List of educational experiences.", "items": { "$ref": "#/components/schemas/Education" } }, "awards": { "type": "array", "description": "List of awards or recognitions received.", "items": { "type": "string" }, "example": [ "The Morrill Scholarship Program" ] }, "certifications": { "type": "array", "description": "List of certifications.", "items": { "$ref": "#/components/schemas/Certification" } }, "memberships": { "type": "array", "description": "List of professional memberships.", "items": { "type": "object", "description": "Membership object with flexible structure.", "additionalProperties": true } }, "patents": { "type": "array", "description": "List of patents.", "items": { "$ref": "#/components/schemas/Patent" } }, "publications": { "type": "array", "description": "List of publications.", "items": { "type": "object", "description": "Publication object with flexible structure.", "additionalProperties": true } } } }, "ScoredProfile": { "type": "object", "description": "A single search result object containing candidate profile and analysis", "properties": { "docid": { "type": "string", "description": "Unique document ID of the candidate profile.", "example": "jason-tysl" }, "insights": { "type": "object", "description": "Analysis and insights relevant to the query.", "properties": { "overall_summary": { "type": "string", "description": "General summary of the candidate's fit for the role.", "example": "Jason Tysl is qualified engineer with 3+ years of experience." }, "query_insights": { "type": "array", "description": "Insights derived from the query, broken down by subquery.", "items": { "type": "object", "properties": { "match_level": { "type": "string", "description": "The degree to which the candidate matches the requirement: Exceeds Expectations,Meets Expectations,Partially Meets,Insufficient Data,Does Not Meet", "example": "Exceeds Expectations" }, "priority": { "type": "string", "description": "Indicates how important this subquery: Essential, Important, Optional", "example": "Essential" }, "short_rationale": { "type": "string", "description": "Concise version of the rationale.", "example": "3+ years as a SWE" }, "rationale": { "type": "string", "description": "Full version of the rationale.", "example": "3+ years as a Software Engineer" }, "subquery": { "type": "string", "description": "Specific subquery analyzed for this insight.", "example": "software engineer" }, "short_quotes": { "type": "array", "description": "Short quotes from the candidate's profile.", "items": { "type": "string", "example": "I have 3+ years of experience in software development." } } } } } } }, "score": { "type": "integer", "description": "Numerical score representing candidate relevance. 4 - great candidate, 3 - good candidate, 2 - worth reviewing, 1 - irrelevant candidate. We don't return irrelevant candidates (score=1) when `profile_scoring=true` unless docid_whitelist is provided.", "example": 4, "enum": [ 1, 2, 3, 4 ] }, "credits_charged": { "type": "integer", "description": "Credits charged for this search result.", "example": 5 }, "profile": { "$ref": "#/components/schemas/Profile" }, "outreach_message": { "type": "string", "description": "Personalized outreach message for the candidate.", "example": "Hi Jason, I noticed your expertise in Python and machine learning..." } } }, "CompanyLeadResult": { "type": "object", "description": "A company search result with associated leads", "properties": { "company": { "$ref": "#/components/schemas/CompanyInfo" }, "leads": { "type": "array", "description": "List of leads found within this company.", "items": { "$ref": "#/components/schemas/ScoredProfile" } }, "score": { "type": "number", "format": "float", "description": "Relevance score for the company match (0..100). 100 means the company is a perfect match for the query.", "example": 85 } } } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } }, "security": [ { "bearerAuth": [] } ] } ````