Generate leads by filters, premade segments, and/or buyer-intent keywords
At least one of filters / segment / audience is required; combining them intersects the criteria. Call the field-options endpoint first to learn the filter surface and valid enum values (never guess enum strings), and the segments endpoint to find premade segment externalIds. Costs 1 data credit per call.
Authorizations
Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.
Body
Lead generation criteria
Company ID (bills its data credits)
Buyer-intent keyword search — the highest-signal input. { segmentSearches: string[] } is free-text topics the lead is actively shopping for (e.g. ['CRM software']); optional b2b: bool biases to business vs consumer intent. Distinct from filters.businessProfile.companyDescription, which describes what the company IS. Combine with filters to intersect intent and firmographics.
Recency window for intent data, 2-10, default 7.
Attribute filters (each a string[] unless noted). Location: city, state, zip_codes. Person: age {minAge,maxAge}, gender, ethnicity, language, education, occupationGroup. Financial: incomeRange, netWorth, homeowner, married, creditRating, creditCardUser, investor. Housing: dwellingType, estimatedHomeValue, mortgageAmount {min,max}. Contact quality: contactNotNulls (fields that must be present). businessProfile (nested object): industry, seniority, department, jobTitle, companyName, companyDomain, companyDescription, employeeCountRange, annualRevenue, sicCodes, naicsCodes. Use lead_field_options for the enumerated fields' valid values.
Max leads, max 100, default 25.
Premade segment externalIds from lead_segments (e.g. "b2b_12636", "b2c_1253").

