Skip to main content
POST
Preview leads from supersearch

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
search_filters
object
required

Search filters to find leads.

skip_owned_leads
boolean

Skip leads that belong to the current workspace

Example:

true

show_one_lead_per_company
boolean

Return only one lead per company

Example:

true

Response

Default Response

number_of_leads
number

Number of leads found for this specific search. A value of 0 indicates that no leads match the criteria. Values greater than 1,000,000 are returned as 1,000,000.

Example:

100

number_of_redacted_results
number

Number of results that were redacted/hidden (for trial users).

Example:

0

leads
object[]

The leads matching the search criteria