Skip to main content
POST
Generate leads by filters, premade segments, and/or buyer-intent keywords

Authorizations

X-API-Key
string
header
required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Body

application/json

Lead generation criteria

companyId
string
required

Company ID (bills its data credits)

filters
object

Attribute filters (each a string[] unless noted), in the exact audience-builder shape. Location: city, state, personalState (person's home state), zip. Person: age {minAge,maxAge}, gender. profile (nested object): incomeRange, netWorth, homeowner, married, children. attributes (nested object): credit_rating, credit_range_new_credit, credit_card_user, investment, cra_code, mortgage_amount {min,max}, occupation_group, ethnic_code, language_code, education, excludeEducation, smoker, single_parent, dwelling_type, estimated_home_value, home_year_built {min,max}, home_purchase_price {min,max}, home_purchase_year {min,max}. Contact quality: notNulls (fields that must be present). businessProfile (nested object): industry, seniority, department, jobTitle, excludeJobTitle, jobTitleMatchMode (string, "contains" default or "exact"), companyName, companyDomain, companyDescription, employeeCount, companyRevenue, sic, companyNaics. Use lead_field_options for the enumerated fields' valid values.

segment
string[]

Premade segment externalIds from lead_segments (e.g. "b2b_12636", "b2c_1253").

audience
object

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.

daysBack
integer

Recency window for intent data, 2-10, default 7.

limit
integer

Max leads, max 100, default 25.

Response

Matching leads plus the total available

Matching leads plus the total available

leads
object[]

Matching lead profiles (up to limit).

totalAvailable
integer

Total leads matching the criteria.