Search download

Initiates the creation of the file with data about emails that matched the search query. When the file is created, it will be available for download. On the successful call, returns the unique identifier that represents the file creation process. The file creation is an asynchronous process because the amount of data that should be exported to the file and the export duration is hard to predict. The call to this endpoint just initiates the file creation. To check the file status and get the download link, send a GET request to the /v4/data/account/downloads/ API endpoint with the identifier returned by this endpoint. The number of rows available for download is determined by the subscription plan.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Options for search params:

Search parameter Operator Value
email
eq
,
not_eq
,
contains
,
not_contains
,
starts
,
ends
Search by email address.
string
Body Params
column_list
array of strings
required

List of columns to download. Supported values: email, sources, updated_at

column_list*
string
length ≤ 254

An optional field with a short file description. Max length: 254 characters.

string
enum
required

The file format to use for the file creation. Supported values: ndjson, csv.

Allowed:
int64
≥ 1

The number of rows the user wants to receive in the current download request.

search_params
array of objects
required

A list of email attributes to filter the search results by. A comprehensive list of valid search parameters is shown in the table below.

search_params*
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json