| filtersbody | object | array | Named criteria (below), or the list form [{ filterId, values, exclude }] from /ai-criteria; each field below names its filterId. A size bucket, range and comparison on the same measure are OR'd; everything else is AND'd. Omit for the whole dataset. |
| excludeFiltersbody | object | Named criteria to leave out (named form only; ignored with the list form). For the true/false fields, true here excludes companies that have it. |
| geoPlaceScopebody | object | { "statesNarrowed": string[] }: the selected states that your cities, counties, ZIPs, metros or radius narrow; the other selected states count whole. In the list form, city-outside, county-outside, zipcode-outside and metro-outside then add places in unselected states. Without it, geography is AND'd like any other criteria. |
| countBybody | string | string[] | dedupe (default: unique contacts, deduplicated by phone unless dedupeBy says otherwise), contacts (distinct named contacts), company (distinct businesses), companyName (distinct company names), executives (distinct executives at the matching companies). An array adds data.counts. |
| filters.statesbody | string[] | Full state names or two-letter codes ("Texas", "TX"); District of Columbia is included. Unknown states are a 400. filterId: state. |
| filters.cityIdsbody | string[] | City names, any case (e.g. "Austin"). filterId: city. |
| filters.countyIdsbody | string[] | County names, with or without "County" (e.g. "Travis"). filterId: county. |
| filters.zipcodeIdsbody | string[] | Five-digit ZIP codes (e.g. "78701"). filterId: zipcode. |
| filters.metroIdsbody | string[] | Metro-area ids from the Navigator's geography catalog; /ai-criteria resolves metro names to them. filterId: metro. |
| filters.radiusbody | object | { lat, lon, miles }: within that many miles of the point; miles must be positive. filterId: radius, values [lat, lon, miles]. |
| filters.npaNxxbody | string[] | Six-digit phone prefixes (area code + exchange), e.g. "512473". filterId: npa-nxx. |
| filters.areaCodebody | string[] | Three-digit area codes, e.g. "512". filterId: area-code. |
| filters.sicBulkCodes, sicKeywordCodes, sicDrilldownCodesbody | string[] | SIC codes or prefixes (2, 4, 6 or 8 digits); a range like "52-59" expands to each prefix. All three lists are OR'd. filterIds: sic-bulk, sic-keyword, sic-drilldown. |
| filters.naicsBulkCodes, naicsKeywordCodes, naicsDrilldownCodesbody | string[] | NAICS codes or prefixes (2 to 6 digits). All three lists are OR'd. filterIds: naics-bulk, naics-keyword, naics-drilldown. |
| filters.employeeBucketsbody | string[] | Employee-count buckets: 1-9, 10-19, 20-49, 50-99, 100-249, 250-499, 500-999, "1000-" (1,000 or more). filterId: employees. |
| filters.employeeExactRangesbody | string[] | "min-max" employees, e.g. "50-75". filterId: employees-exact, values [min, max]. |
| filters.employeeComparisonsbody | string[] | "op:value" employees, op = more (at least), less or equal, e.g. "more:50". filterId: minimum-employees, values [op, value]. |
| filters.revenueExactRangesbody | string[] | "min-max" annual revenue in dollars. filterId: revenue. |
| filters.revenueComparisonsbody | string[] | "op:value" annual revenue in dollars, op = more (above), less or equal. filterId: minimum-revenue. |
| filters.yearStartedRangesbody | string[] | "min-max" years in business, e.g. "5-20". filterId: year-started. |
| filters.yearsInBusinessComparisonsbody | string[] | "op:value" years in business, e.g. "more:10" (started more than 10 years ago). filterId: minimum-year. |
| filters.squareFootageComparisonsbody | string[] | "op:value" building square footage, e.g. "more:5000". filterId: square-footage. |
| filters.locationComparisonsbody | string[] | "op:value" number of additional locations (0 = a single site), e.g. "more:5". filterId: locations. |
| filters.statusbody | string[] | "0" Stand Alone, "1" Head Quarters, "2" Branch. filterId: status. |
| filters.legalStatusbody | string[] | "1" Proprietorship, "2" Partnership, "3" Corporation. filterId: legal-status. |
| filters.executiveGroupbody | string[] | "CEO", "EFO" (CFO), "DECISION MKR", "HR MGR.", "IT DIR.", "OWNER", "PLANT MGR.", "PRES", "PURCHASING DIR.", "VP SALES", "VP MKT", "UNKNOWN". filterId: executive-group. |
| filters.executiveTitlebody | string[] | Four-character executive title codes from the Navigator's title list (e.g. "E9FK" Accounting). filterId: executive-title. |
| filters.executiveGenderbody | string[] | "m" or "f". filterId: executive-gender. |
| filters.ethnicLanguage, ethnicCodebody | string[] | Two-character codes from the Navigator's language and ethnicity lists (e.g. "A4" Arabic). filterIds: ethnic-language, ethnic-code. |
| filters.ethnicGroupbody | string[] | Group names or letter codes, e.g. "Hispanic" or "Y". filterId: ethnic-group. |
| filters.ethnicReligionbody | string[] | Religion names or letter codes, e.g. "Catholic" or "C". filterId: ethnic-religion. |
| filters.qualityFiltersbody | string[] | 100% Phone, 100% Email, 100% Address, 100% Contact Name, 100% Deliverable, Email Verified: every one picked must hold. "All Contacts" turns deduplication off for the dedupe count. filterId: quality-filters. |
| filters.smallBusiness, subsidiary, publicCompany, hasWebsitebody | boolean | true = must be a small business / a subsidiary / a public company / have a website; false = must not. filterIds: small-business, subsidiary, public-company, url (values ["true"], exclude for false). |
| filters.dedupeBybody | string | What the dedupe count deduplicates on: Phone (default), Address, Contact Name or Email. filterId: dedupe-by. |