GeoLead Search: Download Results
Use this API endpoint to download the results of a previously completed GeoLead search. If this is the first time you're downloading the results, credits will be deducted based on the number of valid emails found and the type of search that was run.
Endpoint
https://api.anymailfinder.com
/v5.1/geo-lead/{searchId}/downloadPricing
Credits are charged per row:
- Only valid company emails found: 1 credit per row.
- Only valid decision maker emails found: 2 credits per row.
- Both valid company emails and decision maker emails found: 2 credits per row.
- Risky or no emails found: Free.
- Duplicates already paid for within 30 days are free.
- Credits are only charged the first time results are downloaded.
Authentication
Include your API key using the Authorization header.
Refer to the Authentication page for setup instructions.
Code example
curl -X GET "https://api.anymailfinder.com/v5.1/geo-lead/{searchId}/download?download_as=csv" \-H "Authorization: YOUR_API_KEY" \--output "./output.csv"
Request parameters
Path parameters
| Parameter | Example value | Description |
|---|---|---|
searchIdstring | "blk_123a4b5c" | The unique identifier of the GeoLead search. |
Query parameters
| Parameter | Example value | Description |
|---|---|---|
download_asstring - optional | "xlsx" | Specifies the output file format. Available values:
|
formatstring - optional | "default" | Determines how the output file is formatted. Available values:
|
file_name_column_namestring - optional | "file_name" | If specified, appends a column containing the file name to the downloaded file. |
preview_onlystring - optional | "true" | 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. |
Response
200OK
GeoLead Search results will be downloaded as csv or xlsx format (as specified in the download_as query parameter).
400Bad Request
The request is missing required data or is improperly formatted.
Review the message field to identify and correct the issue.
{"error": "bad_request","message": "..."}
401Unauthorized
The request did not include a valid API key.
Refer to the Authentication page to ensure your API key is properly included.
{"error": "unauthorized","message": "Missing or invalid API key."}
402Payment Needed
Your account does not have enough credits to complete this request.
You can purchase additional credits to continue.
{"error": "upgrade_needed","message": "Your account does not have enough credits. Purchase more at https://app.anymailfinder.com/purchase."}
404Not Found
This error indicates that the GeoLead search was not found.
Ensure the searchId provided in the URL is correct.
{"error": "not_found","message": "The requested resource could not be found."}
Need Help?
Our team is experienced with APIs and is here to help.
Chat with us.