Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

API key. Format: Token

Query Parameters

category
integer

Filter by category ID (from GET /api/categories/).

countries
string[]

Filter by country alpha-2 codes (e.g. 'FR', 'AU'). Repeat for multiple.

include_closed_businesses
enum<boolean>

Set to 'true' to include permanently closed businesses in the preview count. Defaults to 'false'.

Available options:
false,
true
level2_locations
string[]

Filter by level-2 location codes (states/departments).

Response

200 - application/json
preview
object[]
required

Paginated list of matching companies (preview only, no full contact data).

totalCount
integer
required

Total number of leads matching the filters. Use this to estimate credit cost before exporting.

cities
string[]

Distinct cities in the result set.

zipCodes
string[]

Distinct zip/postal codes in the result set.

categories
any[][]

Categories represented in the result set.