bulk

Download a CSV file containing the results of a bulk search.

get/v5.1/bulk/{searchId}/download

Request

  • Base URL: https://api.anymailfinder.com
  • URL: https://api.anymailfinder.com/v5.1/bulk/{searchId}/download
  • Auth: API key in header Authorization

Path parameters

searchIdstring required
Example:blk_xxxxxxxx

The ID of the search

Query parameters

preview_only'true' | 'false'

When true, downloads a preview version of the results without charging credits. Preview files exclude all paid information (such as emails or other data depending on the bulk search type). Defaults to false.

partially_verified'0' | '1'

Include rows with risky emails in the download. Verify bulks only - searches no longer return risky emails. Default: 1 (enabled).

not_found'0' | '1'

Include rows where the email was not found in the download. Default: 1 (enabled).

fully_verified'0' | '1'

Include rows with valid emails in the download. Default: 1 (enabled).

format'default' | 'company-one-email-per-line'

Setting to specify how the output file should be formatted.

file_name_column_namestring
Example:file_name

If specified, appends a column containing the file name to the downloaded file.

download_asstring
Example:csv

Output file format ("csv", "json_arr", "json_obj" or "xlsx", defaults to "csv").

Response

Success

Changes

No recorded changes to this operation across all 1 revision of this API.