People Count
/v2/people/countCount the people a People Search filter set matches, without paging through them, and break the count down by country, department and seniority. Takes the same filters as POST /v2/people/search, so total is the search total_count for those filters. Add group_by for one breakdown per dimension (each value with its exact count, plus how many people have no value), or pivot: true for one row per combination, e.g. how many Directors in Sales there are in each country. Department and seniority are read off the jobs the filters matched. The same request is answered from a cache for up to an hour; metadata.counted_at says when its counts were taken. Free: no credits. Uses 1 unit of the search rate limit. Authenticate with your API key in the x-api-key header.
Body parameters
filtersobjectrequiredThe same filters as POST /v2/people/search, with the same rules: active filters AND together, at least one include condition is required, and job and company filters must match within the same position.
totalis the search total_count for these filters. person_linkedin_url is not supported here, and max_person_per_company does not apply: counts are of every matched person.Child attributes
personobjectoptionalMatch the person themselves, by id, by name, or by LinkedIn URL.
idandnameare OR-ed with each other - a person matching either is returned - and the result AND-s with every other filter, so a picked person and a typed name can sit side by side in one request.linkedin_urllooks up specific profiles and cannot be combined with the other two.Child attributes
idobjectoptionalMatch by person id.
Field Type Description includestring[] Only these people. Use the idvalues returned by People Search results, People Enrich, or Search Suggestions withtype: "person". Max 100 ids.excludestring[] Reject these people (same idvalues). Max 100 ids.nameobjectoptionalMatch by name.
Field Type Description includestring[] Names to match. Every word of a term must appear somewhere in the name, in any order, so "Dmytro Shulha" matches "Dmytro Shulha, PhD" and "Helena Calero" matches "Helena Montoya-Calero". Case-insensitive; diacritics are significant ("Jose" does not match "José"). Any single term qualifies. Max 500 items. excludestring[] Names to reject, matched the same way. Max 500 items. linkedin_urlobjectoptionalLook up specific profiles by URL.
Field Type Description includestring[] Look up specific profiles by LinkedIn URL. The URLs pick the people and every other filter narrows them - except company.name.include, which here only picks which position is returned asprimary_position. Cannot be combined withperson.idorperson.name. Results keep the order of the URLs (sort_bydoes not apply) and each carries thematched_urlit was found by. 1-50 urls.Example:
["https://www.linkedin.com/in/emily-carter-sample/"]
Example
{ "filters": { "person": { "name": { "include": [ "Dmytro Shulha" ] } } } }person_locationobjectoptionalWhere the person is based (their profile location), not their employer - for the company HQ use company_location with headquarters_only: true. Unified location strings resolved to country / state / city, or a region (Europe, EMEA, APAC...); a region minus a country is include ["Europe"], exclude ["Germany"].
Field Type Description includestring[] Match these locations (any of). Unified strings like "United States", "Texas, United States", "San Francisco, California, United States" - or a region like "EMEA", "APAC", "Europe", "Latin America", which expands to its member countries (full list with member countries: GET /v2/enums/regions). Max 100 items, each 2-200 chars. Any value that does not resolve fails the whole request with 400 ( invalid_value, naming it ininvalid_values), even beside values that do: nothing is silently dropped. Look values up with POST /v2/search/suggest (type location).excludestring[] Reject these locations (same unified-string format; a region minus a country works: include ["Europe"], exclude ["Germany"]). Max 100 items, each 2-200 chars. A value that does not resolve is skipped, so check the spelling: a misspelled exclude ("Germny") leaves that place in the results. Example
{ "filters": { "person_location": { "include": [ "Europe" ], "exclude": [ "Germany" ] } } }company_keywordsobjectoptionalFree-text keyword match against the person's COMPANY (see Keyword sources). Defaults to the
specialtiessource only - the broader text sources match far more companies and are much likelier to exceed the resolution limit. Use POST /v2/search/suggest withtype: "company_keywords"for accepted values. Does NOT affect ordering: this resolves to a company-id filter and contributes no relevance score.Field Type Description includestring[]required Phrases to search for. 1-20 items, 3-100 chars each. Matched as phrases: a multi-word entry like "email finder" requires those words adjacent and in order within one of the selected source fields, not merely present somewhere in it. excludestring[] Phrases that disqualify a company. 0-20 items. Matched as phrases, same as include.include_allboolean When true, every phrase in includemust match; otherwise any single match qualifies. default: false.sourcesenum[] Restrict matching to these source fields (see Keyword sources). Omit to use the default source set - see this company_keywordsfilter's own description above for what that is.Example
{ "filters": { "company_keywords": { "include": [ "email marketing" ], "sources": [ "specialties" ] } } }person_job_titleobjectoptionalJob title match. Structured include/exclude + match_mode (CONTAINS/EXACT/SMART), or a boolean_search expression.
Field Type Description includestring[] Job titles to match. Max 100 items, each 2-100 chars. Combined per match_mode. Known abbreviations also match their canonical spelling and vice versa (e.g. "CEO" matches "Chief Executive Officer"), however you spell them - "VP of Marketing", "VP, Marketing" and "Marketing VP" all match what "VP Marketing" matches. Under CONTAINS, terms match any of the roles a position carries - including the secondary roles of combined titles like "Founder & CEO" and the original title text. excludestring[] Job titles to reject. Max 100 items, each 2-100 chars. match_modeenum CONTAINS = the title contains every word of the term, in any order; connector words (of, and, the, ...) are ignored, so "Director of Sales Enablement" also matches "Director, Sales Enablement". EXACT = the person's LinkedIn title is exactly the term, so "founder" does not match "Founder & CEO", "Founder of Acme LLC" or "Fondateur" - use CONTAINS for those. SMART = CONTAINS plus AI-suggested titles the same people hold (synonyms, translations for your locations, related roles - see smart_level), and excludewidened with the other spellings of the excluded roles ("Intern" also excludes "Trainee", "Praktikant"); what was added is listed inmetadata.smart_job_titles, and POST /v2/search/smart-job-titles previews them with how many people each adds. Applies to include/exclude; ignored when boolean_search is set. default: "CONTAINS".Allowed values:
CONTAINSEXACTSMARTsmart_levelenum How far match_mode SMART reaches. SAME_ROLE = other ways to write the same role (synonyms, abbreviations, plurals, translations): "VP of Sales" -> "Sales VP". SIMILAR (default) = also closely related roles of the same function and level: "Head of Sales" -> "Sales Director". RELATED = also broader roles in the same function: "SDR" -> "Account Executive". Ignored unless match_mode is SMART. default: "SIMILAR". Allowed values:
SAME_ROLESIMILARRELATEDboolean_searchstring Boolean / Cartesian title query, e.g. "(CEO OR CTO) AND !Intern". Syntax: bareword=contains; 'single quotes'=contains too, and the way to write a title with a space in it - 'vp marketing' matches exactly what include: ["vp marketing"] matches; "double quotes"=exact; backticks=words in order with connectors bridged, sovp marketingfinds "VP of Marketing" but not "VP Sales and Marketing" or "Marketing VP"; !=exclude, AND/OR, ()=grouping. Max 500 terms, depth 5, each term 2-100 chars. AND and OR cannot be mixed at the same nesting level - use parentheses to group. Mutually exclusive with include/exclude. max length: 20000.Example
{ "filters": { "person_job_title": { "include": [ "Product Marketing Manager", "Growth Marketing Manager" ], "exclude": [ "Assistant" ], "match_mode": "CONTAINS" } } }person_seniorityobjectoptionalSeniority (see Seniorities).
Field Type Description includeenum[] Seniority levels to match (any of). See Seniorities. excludeenum[] Seniority levels to reject. See Seniorities. Example
{ "filters": { "person_seniority": { "include": [ "C-Suite", "VP", "Director" ] } } }person_departmentobjectoptionalDepartment (see Departments).
Field Type Description includeenum[] Departments to match (any of). Accepts a department group ("Sales", "Legal") or a specific sub-department ("Sales Operations", "Founder"). A group matches everyone in it, including people with no specific sub-department; a sub-department matches only that sub-department. See Departments. excludeenum[] Departments to reject. A group rejects everyone in it, including people with no specific sub-department; a sub-department rejects only that sub-department. See Departments. Example
{ "filters": { "person_department": { "include": [ "Marketing", "Sales" ], "exclude": [ "Accounting" ] } } }person_months_in_current_roleobjectoptionalMonths in the current role (tenure of the active position). Integer months 0-600.
Field Type Description mininteger Minimum whole months (inclusive), 0-600. Optional. min: 0, max: 600. maxinteger Maximum whole months (inclusive), 0-600, must be >= min. Optional. min: 0, max: 600. Example
{ "filters": { "person_months_in_current_role": { "min": 6, "max": 24 } } }person_months_in_current_companyobjectoptionalMonths at the current company (tenure since joining). Integer months 0-600.
Field Type Description mininteger Minimum whole months (inclusive), 0-600. Optional. min: 0, max: 600. maxinteger Maximum whole months (inclusive), 0-600, must be >= min. Optional. min: 0, max: 600. Example
{ "filters": { "person_months_in_current_company": { "min": 12 } } }person_job_changeobjectoptionalRecent job change: current role started within timeframe_months, optionally narrowed by change_type.
Field Type Description timeframe_monthsintegerrequired Months since the current role started, counted in CALENDAR months the way LinkedIn counts them: a role is "N months" if it spans N calendar months inclusive, so a role begun any time in August is 2 months old on 1 September. timeframe_months: 1therefore matches only roles begun in the current month. Any whole number from 1 to 1000. Replaces the formertimeframe_days, which accepted only 30, 60, 90, 180, 270 or 365. min: 1, max: 1000.Example:
3change_typeenum any = any recent role change; new_company = also changed company; promotion = changed role at the same company (approximation, includes lateral moves). default: "any". Allowed values:
anypromotionnew_companyExample
{ "filters": { "person_job_change": { "timeframe_months": 3, "change_type": "new_company" } } }companyobjectoptionalCompany the person works at - by our company
id, bydomain, byname, or by LinkedIn numericlinkedin_id.Child attributes
idobjectoptionalMatch by company id (the
idreturned by Company Search and in People Search results). Composes with every other filter: pair it with person_job_title to narrow a company list down to the roles you want. An exactcompany.namecombines with it as OR (people at any listed id or any listed name);company.domain,company_keywordsand a CONTAINScompany.nameAND with it.Field Type Description includestring[] Only people who work at one of these companies. Use the idvalues returned by Company Search or in People Search results. Combines with an exactcompany.nameas OR (a person at any listed id or any listed name);company.domain,company_keywordsand a CONTAINScompany.namestill narrow it. Max 20000 ids.excludestring[] Reject people who work at any of these companies (same idvalues). Max 20000 ids.domainobjectoptionalMatch by company website domain. Resolved to the same company-id constraint as
company.id, so the two AND together when both are given.Field Type Description includestring[] Only people who work at the organization that owns one of these domains, e.g. "stripe.com" - see match_modefor which of its company pages count. Scheme, "www." and any path are stripped. Max 100 items.excludestring[] Reject people whose company is on one of these domains. match_modeenum Which company pages an includedomain stands for. ORGANIZATION (default) = every company page that belongs to the organization owning the domain: its main page, its regional, brand and subsidiary pages. A small page that only links to the domain - a business hosted on a platform, a same-named company - is left out. PRIMARY = only the one main company page of the domain, leaving out the organization's other pages. LINKEDIN_WEBSITE = only the organization's pages whose own LinkedIn website is on the domain, so the domain is never inferred: "stripe.com", "stripe.com/jobs" and "jobs.stripe.com" all match "stripe.com"; a page that lists another site, or no website, does not.excludeis not affected: it always rejects every company on the domain. default: "ORGANIZATION".Allowed values:
ORGANIZATIONPRIMARYLINKEDIN_WEBSITEExample
{ "filters": { "company": { "domain": { "include": [ "stripe.com" ] } } } }nameobjectoptionalMatch by company name - exact by default, or the term within the name with match_mode: CONTAINS. An exact name combines with
company.idas OR (people at any listed name or any listed id); a CONTAINS name ANDs with it. Besideperson.linkedin_url,includeis only a primary-position hint, not a filter (excludestill filters).Field Type Description includestring[] Company names to match. Combined per match_mode. With EXACT, a value shaped like a website ("stripe.com", "https://www.stripe.com/about") also matches the company on that domain. Max 500 items. excludestring[] Company names to reject. With EXACT, a website-shaped value also rejects the company on that domain. match_modeenum EXACT (default) = the whole company name equals the term, case-insensitive. CONTAINS = the name contains the term as written, case-insensitive, starting at a word ("Haven Health" matches "Haven Health Management" and "New Haven Healthcare"). A match inside a longer word ("nails" in "AllNailSpa") comes back only for a term that matches no name at a word start, and reliably only for a single-word term. A multi-word term that matches no name as written falls back to names holding all of its words in any order ("Oak Park River Forest High School" matches "Oak Park and River Forest High School"). An excludeterm matches anywhere in the name ("soft" also rejects "Microsoft"). Resolved against the company index and capped; narrow the term if the request is rejected. default: "EXACT".Allowed values:
EXACTCONTAINSlinkedin_idobjectoptionalOnly people who work at these LinkedIn companies, by LinkedIn's numeric company id. Composes with every other filter as an AND, including with
company.name(unlikecompany.id, which ORs with an exact name). Have a company LinkedIn URL instead? Usecompany.linkedin_url.Field Type Description includeinteger[] Match these LinkedIn companies. LinkedIn's numeric company id. Company LinkedIn URLs are not accepted here: People Search takes them as company.linkedin_url; elsewhere enrich the company bylinkedin_urland put theidit returns incompany.id. Max 500 items.Example:
[162479]excludeinteger[] Reject these LinkedIn companies. LinkedIn's numeric company id. Company LinkedIn URLs are not accepted here: People Search takes them as company.linkedin_url; elsewhere enrich the company bylinkedin_urland put theidit returns incompany.id. Max 500 items.Example
{ "filters": { "company": { "linkedin_id": { "include": [ 2135371 ] } } } }linkedin_urlobjectoptionalMatch by LinkedIn company URL (https://www.linkedin.com/company/stripe/ - vanity slug or numeric id). Each URL is resolved to the companies we hold for that LinkedIn page and then works exactly like
company.id: its includes join thecompany.idincludes (people at any of them), its excludes thecompany.idexcludes. A URL we know no company for matches nobody (200, empty page); a value that is not a LinkedIn company URL is a 400 (invalid_format).Field Type Description includestring[] Only people who work at these companies, by LinkedIn company page URL (vanity slug or numeric id, Sales Navigator company URLs too). A URL we know no company for matches nobody. Max 500 items. Example:
["https://www.linkedin.com/company/stripe/"]excludestring[] Reject people who work at these companies, by LinkedIn company page URL. Max 500 items. Example
{ "filters": { "company": { "linkedin_url": { "include": [ "https://www.linkedin.com/company/stripe/" ] } } } }
Example
{ "filters": { "company": { "name": { "include": [ "Intercom", "Stripe" ] } } } }company_industryobjectoptionalIndustry of the person's company (see Industries; any casing). An unknown value, even one in a list of good ones, fails the request with 400
value_not_allowed, withsuggested_valuesfor near spellings.Field Type Description includestring[] Industries or industry GROUPS to match (any of). A group name matches every industry in that category. See Industries for both. Example:
["Agriculture & Mining","Software Development"]excludestring[] Industries or industry GROUPS to reject. A group name rejects every industry in that category. See Industries for both. Example
{ "filters": { "company_industry": { "include": [ "Software Development", "IT Services & IT Consulting" ], "exclude": [ "Staffing & Recruiting" ] } } }company_headcount_rangeenum[]optionalBucketed headcount range of the company (see Employee ranges).
Example
{ "filters": { "company_headcount_range": [ "51-200", "201-500" ] } }company_countryobjectoptionalCountry of the person's company, as ISO alpha-2 codes (Countries). Any resolved office country counts by default (headquarters included) - same contract as company_location and as Company Search; see headquarters_only. For city/state-level filtering use company_location. sort_by=company_country always orders by the registered headquarters country, independent of headquarters_only.
Field Type Description includestring[] Match values in this list - any single value qualifies (exact, case-insensitive). Optional - provide include and/or exclude. excludestring[] Reject values in this list. 0-500 items. headquarters_onlyboolean When true, match the company headquarters country only. When false (default), any office country we have resolved counts, headquarters included: includes widen (a company with an office there matches) and excludes tighten symmetrically (a company with an office there is rejected). default: false. Example
{ "filters": { "company_country": { "include": [ "US", "CA", "GB" ], "headquarters_only": true } } }company_typeobjectoptionalLegal/ownership type of the person's company (see Company types).
Field Type Description includeenum[] Company types to match (any of). Allowed values:
Privately HeldPublic CompanyNon ProfitSelf OwnedSelf EmployedPartnershipEducationalGovernment AgencyUnknownexcludeenum[] Company types to reject. Allowed values:
Privately HeldPublic CompanyNon ProfitSelf OwnedSelf EmployedPartnershipEducationalGovernment AgencyUnknownExample
{ "filters": { "company_type": { "include": [ "Privately Held", "Public Company" ] } } }company_business_typeobjectoptionalAudience type of the person's company (see Business types). Values: B2B, B2C, Nonprofit, Unknown.
Field Type Description includeenum[] Business types to match (any of). Allowed values:
B2BB2CNonprofitUnknownexcludeenum[] Business types to reject. Allowed values:
B2BB2CNonprofitUnknownExample
{ "filters": { "company_business_type": { "include": [ "B2B" ] } } }company_revenue_streamobjectoptionalRevenue model of the person's company (see Revenue streams).
Field Type Description includeenum[] Revenue streams to match (any of). Allowed values:
Professional ServicesProduct SalesGrants / DonationsSubscriptions / RecurringProject / Contract WorkEvent / Experience RevenueTransaction FeesRental / LeasingAdvertisingFinancial ServicesLicensing / IPUnknownexcludeenum[] Revenue streams to reject. Allowed values:
Professional ServicesProduct SalesGrants / DonationsSubscriptions / RecurringProject / Contract WorkEvent / Experience RevenueTransaction FeesRental / LeasingAdvertisingFinancial ServicesLicensing / IPUnknownExample
{ "filters": { "company_revenue_stream": { "include": [ "Subscriptions / Recurring", "Product Sales" ] } } }company_ai_industryobjectoptionalAI industry of the person's company (see AI Industries): an industry group or a sub-industry. A group matches all its sub-industries. Casing does not matter, and "&" is read as "and".
Field Type Description includeenum[] AI industries to match (any of). A group matches all its sub-industries; a sub-industry matches only itself. Allowed values:
Software and ITHealthcare and Life SciencesFinance and InsuranceEnergy, Utilities and Environmental ServicesIndustrial Manufacturing and MaterialsReal Estate and ConstructionRetail and Consumer ChannelsTransportation and LogisticsProfessional, Business and Legal ServicesEducation and TrainingMedia, Entertainment and CultureHospitality, Food and Travel ServicesPersonal and Home ServicesAgriculture, Forestry and FisheriesAutomotive, Aerospace and Defense ManufacturingNon-Profit, Public Sector and Education (Non-Commercial)AI and ML PlatformsAgriculture and Forestry SoftwareBlockchain and Web3Carriers and ISPsCloud and Infrastructure SoftwareConsumer SoftwareData and Analytics SoftwareDeveloper Tools and PlatformsEnterprise Software SolutionsFinancial Services SoftwareGovernment and Public Sector SoftwareHardware and NetworkingHealthcare SoftwareIoT and Embedded Systems SoftwareIT Services and CybersecurityManufacturing SoftwareMetaverse, AR/VR and Other Emerging PlatformsQuantum Computing SoftwareReal Estate and PropTech SoftwareRetail and Ecommerce SoftwareSecurity and Identity SoftwareBiotechnology and PharmaceuticalsDigital Health and TelemedicineHospitals, Clinics and Outpatient CareMedical Devices and Diagnostic EquipmentMedical Testing and Clinical LaboratoriesMental Health and Rehabilitation ServicesPharma Distribution and CRO ServicesBanking and LendingCapital Markets and CryptocurrencyCryptocurrency and Blockchain ServicesFinancial Services PlatformsInsurance and InsurTechInvestment Management and WealthTechVenture Capital and Private EquityElectric Power and Grid ManagementNuclear and Advanced GenerationOil and Gas Exploration, Production and ServicesRenewable Energy and Clean TechSustainability Tech and Environmental ConsultingWater, Waste and Environmental Management3D Printing and Advanced ManufacturingBuilding Materials and ChemicalsConsumer Goods and AppliancesElectronics and Computer EquipmentFood, Beverage and Tobacco ProductionIndustrial Machinery and EquipmentMining, Metals and Natural ResourcesArchitecture, Urban Planning and Green BuildingCommercial Real Estate Development and LeasingConstruction and Civil Engineering ServicesProperty and Facility ManagementResidential Real Estate Development and BrokerageSpecialty Construction ProductsAutomotive Service and Collision RepairBrick-and-Mortar RetailMedia and Entertainment RetailOnline Commerce and MarketplacesRetail TechnologySpecialty Auctions and CollectiblesWholesale and DistributionAutonomous Vehicles and Drone DeliveryCar and Truck RentalFreight and CargoLogistics TechnologyPassenger Transit and MobilityWarehousing, Fulfillment and 3PL ServicesAccounting, Audit and Financial AdvisoryAdvertising, Marketing and Multimedia DesignDefense and Government ServicesFacilities Management and Commercial CleaningHuman Resources, Staffing and RecruitmentLegal Services and Regulatory ComplianceManagement Consulting and Strategy ConsultingTranslation, Document and Information ManagementCorporate Training and Learning and DevelopmentE-Learning Platforms and EdTechK-12 and Higher Education InstitutionsTest Prep, Tutoring and After-School ServicesVocational Training and Certification ProgramsDigital Publishing and Streaming PlatformsFilm, Television and BroadcastingGaming, Esports and Interactive EntertainmentLive Events, Experiences and Ticketed AttractionsMuseums, Art Galleries and Cultural PreservationMusic, Audio and Podcast ServicesSports and RecreationFood and Beverage ServicesHospitality and LodgingTravel Agencies and Leisure ServicesFuneral Homes and Related ServicesHome ServicesPersonal Care and WellnessVeterinary Care and Pet ServicesAgriTech and Precision FarmingAquaculture and FisheriesCrop Farming and Livestock ProductionFarming Equipment and SuppliesForestry, Logging and Wood ProductsMining and ExtractionAviation and Aerospace Component ManufacturingAutomotive and Rental RetailCommercial Space InnovationDefense Systems and Marine ManufacturingMotor Vehicle and Parts ManufacturingGovernment Administration and Municipal ServicesNGOs, Charities and Community OrganizationsPublic Healthcare and Social ServicesPublic/Private Research Institutions and Educational FoundationsStudent Organizations and Campus Servicesexcludeenum[] AI industries to reject. A group rejects all its sub-industries; a sub-industry rejects only itself. Allowed values:
Software and ITHealthcare and Life SciencesFinance and InsuranceEnergy, Utilities and Environmental ServicesIndustrial Manufacturing and MaterialsReal Estate and ConstructionRetail and Consumer ChannelsTransportation and LogisticsProfessional, Business and Legal ServicesEducation and TrainingMedia, Entertainment and CultureHospitality, Food and Travel ServicesPersonal and Home ServicesAgriculture, Forestry and FisheriesAutomotive, Aerospace and Defense ManufacturingNon-Profit, Public Sector and Education (Non-Commercial)AI and ML PlatformsAgriculture and Forestry SoftwareBlockchain and Web3Carriers and ISPsCloud and Infrastructure SoftwareConsumer SoftwareData and Analytics SoftwareDeveloper Tools and PlatformsEnterprise Software SolutionsFinancial Services SoftwareGovernment and Public Sector SoftwareHardware and NetworkingHealthcare SoftwareIoT and Embedded Systems SoftwareIT Services and CybersecurityManufacturing SoftwareMetaverse, AR/VR and Other Emerging PlatformsQuantum Computing SoftwareReal Estate and PropTech SoftwareRetail and Ecommerce SoftwareSecurity and Identity SoftwareBiotechnology and PharmaceuticalsDigital Health and TelemedicineHospitals, Clinics and Outpatient CareMedical Devices and Diagnostic EquipmentMedical Testing and Clinical LaboratoriesMental Health and Rehabilitation ServicesPharma Distribution and CRO ServicesBanking and LendingCapital Markets and CryptocurrencyCryptocurrency and Blockchain ServicesFinancial Services PlatformsInsurance and InsurTechInvestment Management and WealthTechVenture Capital and Private EquityElectric Power and Grid ManagementNuclear and Advanced GenerationOil and Gas Exploration, Production and ServicesRenewable Energy and Clean TechSustainability Tech and Environmental ConsultingWater, Waste and Environmental Management3D Printing and Advanced ManufacturingBuilding Materials and ChemicalsConsumer Goods and AppliancesElectronics and Computer EquipmentFood, Beverage and Tobacco ProductionIndustrial Machinery and EquipmentMining, Metals and Natural ResourcesArchitecture, Urban Planning and Green BuildingCommercial Real Estate Development and LeasingConstruction and Civil Engineering ServicesProperty and Facility ManagementResidential Real Estate Development and BrokerageSpecialty Construction ProductsAutomotive Service and Collision RepairBrick-and-Mortar RetailMedia and Entertainment RetailOnline Commerce and MarketplacesRetail TechnologySpecialty Auctions and CollectiblesWholesale and DistributionAutonomous Vehicles and Drone DeliveryCar and Truck RentalFreight and CargoLogistics TechnologyPassenger Transit and MobilityWarehousing, Fulfillment and 3PL ServicesAccounting, Audit and Financial AdvisoryAdvertising, Marketing and Multimedia DesignDefense and Government ServicesFacilities Management and Commercial CleaningHuman Resources, Staffing and RecruitmentLegal Services and Regulatory ComplianceManagement Consulting and Strategy ConsultingTranslation, Document and Information ManagementCorporate Training and Learning and DevelopmentE-Learning Platforms and EdTechK-12 and Higher Education InstitutionsTest Prep, Tutoring and After-School ServicesVocational Training and Certification ProgramsDigital Publishing and Streaming PlatformsFilm, Television and BroadcastingGaming, Esports and Interactive EntertainmentLive Events, Experiences and Ticketed AttractionsMuseums, Art Galleries and Cultural PreservationMusic, Audio and Podcast ServicesSports and RecreationFood and Beverage ServicesHospitality and LodgingTravel Agencies and Leisure ServicesFuneral Homes and Related ServicesHome ServicesPersonal Care and WellnessVeterinary Care and Pet ServicesAgriTech and Precision FarmingAquaculture and FisheriesCrop Farming and Livestock ProductionFarming Equipment and SuppliesForestry, Logging and Wood ProductsMining and ExtractionAviation and Aerospace Component ManufacturingAutomotive and Rental RetailCommercial Space InnovationDefense Systems and Marine ManufacturingMotor Vehicle and Parts ManufacturingGovernment Administration and Municipal ServicesNGOs, Charities and Community OrganizationsPublic Healthcare and Social ServicesPublic/Private Research Institutions and Educational FoundationsStudent Organizations and Campus ServicesExample
{ "filters": { "company_ai_industry": { "include": [ "Finance and Insurance" ], "exclude": [ "Banking and Lending" ] } } }company_foundedobjectoptionalFounded-year range of the person's company. min/max are inclusive; either may be omitted.
Field Type Description minnumber Lower bound (inclusive). Optional. maxnumber Upper bound (inclusive). Must be >= min. Optional. Example
{ "filters": { "company_founded": { "min": 2015, "max": 2023 } } }company_headcount_customobjectoptionalRaw headcount range of the person's company. min/max are inclusive; either may be omitted.
Field Type Description minnumber Lower bound (inclusive). Optional. maxnumber Upper bound (inclusive). Must be >= min. Optional. Example
{ "filters": { "company_headcount_custom": { "min": 50, "max": 1000 } } }company_headcount_by_departmentobject[]optionalHeadcount of the person's company by department, optionally within one country or state. Rows AND together; each row is a
departmentplusminand/ormaxpeople (amaxalso matches companies with nobody in the department). 1-10 rows.Field Type Description departmentenumrequired Department group ("Sales") or sub-department ("Sales Operations"); see Departments. Casing does not matter. Example:
"Product Development"locationstring Count only people located in this ONE location, which must resolve to a country or a state ("Germany", "California, United States"). A city or a multi-country region answers 400. Omit for anywhere. 2-200 chars. Example:
"California, United States"mininteger At least this many people (inclusive). Integer 0-1,000,000. Example:
10maxinteger At most this many people (inclusive). Integer 0-1,000,000, at least min. Companies with no people in the department count as 0 and match. Example:
20Example
{ "filters": { "company_headcount_by_department": [ { "department": "Sales", "min": 10 } ] } }company_naicsobjectoptionalNAICS codes (numeric) of the person's company. Matches if any code on the company is in the list.
Field Type Description includenumber[] Match numeric values in this list - any single value qualifies. Optional - provide include and/or exclude. excludenumber[] Reject numeric values in this list. 0-500 items. Example
{ "filters": { "company_naics": { "include": [ 541511, 541512 ] } } }company_locationobjectoptionalLocation of the person's company (the matched position's company), as unified location strings - same format as person_location. Any resolved office counts by default; see headquarters_only.
Field Type Description includestring[] Match these locations (any of). Unified strings like "United States", "Texas, United States", "San Francisco, California, United States" - or a region like "EMEA", "APAC", "Europe", "Latin America", which expands to its member countries (full list with member countries: GET /v2/enums/regions). Max 100 items, each 2-200 chars. Any value that does not resolve fails the whole request with 400 ( invalid_value, naming it ininvalid_values), even beside values that do: nothing is silently dropped. Look values up with POST /v2/search/suggest (type location).excludestring[] Reject these locations (same unified-string format; a region minus a country works: include ["Europe"], exclude ["Germany"]). Max 100 items, each 2-200 chars. A value that does not resolve is skipped, so check the spelling: a misspelled exclude ("Germny") leaves that place in the results. headquarters_onlyboolean When true, match the company headquarters location only. When false (default), any office location we have resolved counts, headquarters included: includes widen (a company with an office there matches) and excludes tighten symmetrically (a company with an office there is rejected). default: false. Example
{ "filters": { "company_location": { "include": [ "San Francisco, California, United States" ], "headquarters_only": true } } }company_technologiesobjectoptionalWeb technologies detected on the company website, by id: the
valueof aPOST /v2/search/suggestrow withtype: technologyandkind: technology. Websites are rescanned every 30 days. Matches the company of the matched position. Not available yet: answers 400 until the people index carries company technologies.Field Type Description includestring[] Technology ids to match. match_mode: ANY(default): a company using any of them qualifies;ALL: it must use every one. Max 500.Example:
["3421"]excludestring[] Reject companies using any of these technology ids. Max 500. match_modeenum How includecombines:ANY(default) - at least one;ALL- every one, on the same company. default: "ANY".Allowed values:
ANYALLExample
{ "filters": { "company_technologies": { "include": [ "3421" ] } } }company_technology_categoriesobjectoptionalTechnology categories (CMS, Ecommerce, Analytics, ...), by id: the
valueof a suggest row withkind: category. A category matches a company using any technology in it. Matches the company of the matched position. Not available yet: answers 400 until the people index carries company technologies.Field Type Description includestring[] Category ids to match (any of). Max 200. Example:
["1"]excludestring[] Reject companies using any technology in these category ids. Max 200. Example
{ "filters": { "company_technology_categories": { "include": [ "1" ] } } }contact_detailsobjectoptionalContact data: email/phone availability and status (global), plus your workspace's reveal state.
Child attributes
emailobjectoptionalEmail availability/quality (global) + your workspace reveal state.
Field Type Description statusenum[] Contact-level email status (best stored email; valid wins). Match-any: valid (>=1 valid email, or an email your workspace entered for the person), invalid, accept_all, not_found (no stored email and none entered by your workspace). Allowed values:
validinvalidaccept_allnot_foundrevealedboolean true = only contacts whose email your workspace already revealed; false = only those NOT revealed. Requires an authenticated workspace. phoneobjectoptionalPhone availability (global) + your workspace reveal state.
Field Type Description statusenum[] Contact-level phone status from our lookup store. Match-any: found (number on file), not_found (looked up, none), unknown (never looked up). Allowed values:
foundnot_foundunknownrevealedboolean true = only contacts whose phone your workspace already revealed; false = only those NOT revealed. Requires an authenticated workspace.
Example
{ "filters": { "contact_details": { "email": { "status": [ "valid", "accept_all" ], "revealed": false }, "phone": { "status": [ "found" ] } } } }listsobjectoptionalYour workspace CRM list membership: include/exclude list ids, saved any/none, and saved-at range.
Child attributes
includestring[]optionalOnly contacts your workspace saved into these list ids. Max 100 ids, each 1-64 chars.
excludestring[]optionalHide contacts your workspace saved into these list ids. Max 1000 ids, each 1-64 chars.
savedenumoptionalany = only contacts your workspace saved, in a list or not; none = only contacts your workspace has not saved; without_list = only contacts your workspace saved but did not file into any list.
Allowed values:
anynonewithout_listsaved_atobjectoptionalFilter by when the contact was saved into a list (workspace-scoped).
Field Type Description fromstring Saved on/after this date (ISO 8601). Optional. tostring Saved on/before this date (ISO 8601). Optional.
Example
{ "filters": { "person_job_title": { "include": [ "Product Marketing Manager" ] }, "lists": { "saved": "none" } } }duplicatesobjectoptionalDeduplication against your workspace's history: hide people already exported.
Field Type Description exclude_exportedboolean true = hide people your workspace already exported through POST /v2/people/export. Exclude-only: it removes rows and never counts as an include condition. Requires an authenticated workspace. Example
{ "filters": { "duplicates": { "exclude_exported": true } } }max_person_per_companyintegeroptionalmin: 1max: 100Cap the number of people returned per company across the whole result set (1-100). A person is counted against the company of the position that matched your company filters, or their current/primary position when no company filter is set. Of the colleagues competing for a company slot, one we hold a valid email for is kept, and your sort decides between them (and picks the representative outright when none of them has one). Results stay in your sort order either way. For result sets above 25000 matches the representative is simply whoever leads your sort, and total_count is a rounded PRE-cap estimate (pagination.total_is_estimate=true) - an upper bound, so an export of that selection returns fewer people. At or below it both are exact.
Example
{ "filters": { "person_job_title": { "include": [ "Product Marketing Manager" ] }, "max_person_per_company": 2 } }
group_byenum[]optionalBreak the total down by up to three dimensions:
country(where the person is based, ISO code),department(the department group of the matched job, e.g. "Sales") andseniority(the level of the matched job, e.g. "Director"). Department and seniority come from the jobs the filters matched (every current job when the filters name no job or company condition), so a person with two matched jobs counts once for each and the values can add up to more thantotal. Omit for the total alone.Allowed values:
countrydepartmentseniorityExample
{ "group_by": [ "country", "seniority" ] }pivotbooleanoptionaldefault: falsefalse (default): one breakdown per group_by dimension, each with its
unknowncount. true: one row per combination of values (e.g. US + Sales + Director) that holds anyone, sorted by count; needs at least two dimensions. A pivot row describes one job: its department and seniority come from the same position. People with no value for a dimension are not in any pivot row.country_limitintegeroptionalmin: 1max: 250default: 50How many countries to return, the largest first (each count is exact). At most 100 in a pivot by country.
Responses
For error handling see Errors. Response objects are described in Person object and Company object.
