Bulk Email Finderⓘ API Documentation
Email search engine - Send file
The email-finder/sendfile API allows you to send a file for bulk email finderⓘ. This guide will provide everything you need to know on how to find email addresses in bulk via API.
There is no restriction on the file size, number of emails, or number of files you can submit using this endpoint.
Each search will consume 20 credits if a valid email format is returned. If you are a monthly subscriber, the API call will consume 1 Email Finderⓘ query if a valid format is returned. As long as you have the available queries via subscription or the credits in your account to cover the number of searches submitted in the file, your file will be accepted.
To avoid API interruptions, consider activating AutoPay in your ZeroBounce account settings to ensure you never run out of credits.
POST /EMAIL-FINDER/SENDFILE
API URL: https://bulkapi.zerobounce.net/email-finder/sendfile
The content type of the body should be multipart/form-data.
Link parameters
- ParameterDescription
- fileThe CSV or TXT file. Byte array content for the submitted file. The content header is of type "text/csv"
- api_keyYour API key, which is located in your account. (Required)
- domain_columnThe domain column index in the file. The index starts from 1 (required).
- first_name_columnThe column index for the first name column. (It is mandatory that one of the columns, either the first name or the full name column, be filled in)
- last_name_columnThe column index for the last name column. (Optional)
- middle_name_columnThe column index for the middle name column. (Optional)
- full_name_columnThe column index for the full name column. (It is mandatory that one of the columns, either the first name or the full name column, be filled in)
- has_header_rowIf the first row of the submitted file is a header row; true or false (optional)
END POINT ANSWER
Successful Response
Error Response
Do you need help submitting your file to the bulk email search engine? Tell us what you need: our team is available at any time to assist you.
Email search engine - Archive status
The email finderⓘ's filestatus API returns the file processing status for the file that was sent using the email finderⓘ's sendfile API.
GET /EMAIL-FINDER/FILESTATUS
API URL: https://bulkapi.zerobounce.net/email-finder/filestatus
Link parameters
- ParameterDescription
- api_keyYour API key, which is located in your account. (Required)
- file_idThe file ID returned when calling the sendfile API.
If you want to call the API from your browser to test it, replace the API KEY parameter with your unique API key (found in your ZeroBounce account settings) and the FILE ID parameter with the returned file ID from sendfile API:
ENDPOINT RESPONSE
Successful Response
Error Response
For each email address it verifies, the email finderⓘ API consumes 1 query (if you have an active ZeroBounce One subscription ). If you have credits or use Pay-As-You-Go, Email Finderⓘ will consume 20 credits per successful result. If you use the API regularly, take measures to ensure your account is replenished periodically with credits to avoid interruptions.
Need help determining the status of your email finderⓘ API files? Please reach out to our Customer Support team. We are available around the clock to answer any questions and assist you.
Email Finderⓘ - Get File
The email finderⓘ getfile API allows you to get the email finderⓘ results for the file you submitted using email finderⓘ sendfile API.
GET /EMAIL-FINDER/GETFILE
API URL: https://bulkapi.zerobounce.net/email-finder/getfile
Link parameters
- ParameterDescription
- api_keyYour API Key, found in your account. (Required)
- file_idThe returned file ID when calling sendfile API.
If you want to call the API from your browser to test it, all you have to do is to replace the API KEY parameter with your API key (found in your ZeroBounce account settings ) and the FILE ID with the returned file ID from sendfile API:
ENDPOINT RESPONSE
Successful Response
The email finderⓘ getfile API returns the email finderⓘ results file. The returned content type is "application/octet-stream". You can get the file name from response.Content.Headers.ContentDisposition.FileName. If you are calling the API directly from the browser, you can either save or open the results file from the browser.
Error Response
Need help getting your email finderⓘ API results? Our team is here to lend a hand. Reach out to us anytime. We offer 24/7 customer support.
Email Finderⓘ - Delete File
The email finderⓘ deletefile API allows you to delete the file that you submitted using the email finderⓘ sendfile API. Please note that the file can be deleted only when its status is Complete.
GET /EMAIL-FINDER/GETFILE
API URL: https://bulkapi.zerobounce.net/email-finder/deletefile
Link parameters
- ParameterDescription
- api_keyYour API Key, found in your account. (Required)
- file_idThe returned file ID when calling sendfile API.
ENDPOINT RESPONSE
Below you can find examples of both successful and errors responses.
Successful Response
Error Response
If you need help deleting your email finderⓘ API file, let us know. Our team is here 24/7 to answer any questions and make things easier for you.