Bulk Email Search: Retrieve Info

Use this API endpoint to retrieve details and the current status of a previously created Bulk Email Search. It allows you to monitor progress or retrieve metadata about a specific search using the unique searchId.

Endpoint

GET
https://api.anymailfinder.com
/v5.1/bulk/{searchId}

Pricing

This endpoint is free to use.

Credits are only charged when you download the results for the first time.

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/bulk/{searchId}" \
-H "Authorization: YOUR_API_KEY"

Request parameters

Path parameters

ParameterExample valueDescription
searchId
string
"blk_123a4b5c"The unique identifier of the bulk search.

Response

200OK

The request was successful. The response includes detailed information about the specified bulk search, including its status, counts, and associated metadata. Use this data to monitor the progress of the search or verify its completion.

{
"counts": {
"failed": 0,
"found_unknown": 0,
"found_valid": 0,
"not_found": 0,
"total": 0
},
"created_at": "2025-01-08T13:25:36.457Z",
"credits_needed": 0,
"decision_maker_category": "string",
"file_name": "string",
"id": "string",
"paid": true,
"started_running_at": "2025-01-08T13:25:36.457Z",
"status": "queued"
}
PropertyTypeDescription
statusstringThe current status of the bulk search. Possible values:
  • on_deck: Bulk file uploaded but columns not mapped yet (internal status).
  • queued: Bulk search is queued and awaiting processing.
  • running: Bulk search is currently being processed.
  • paused: Bulk search processing is temporarily paused.
  • completed: Bulk search processing is complete.
  • failed: Bulk search processing failed due to an error.
counts.failedintegerNumber of rows where the search failed.
counts.found_unknownintegerNumber of rows with risky emails found.
counts.found_validintegerNumber of rows with valid emails found.
counts.not_foundintegerNumber of rows where no email was found.
counts.totalintegerTotal number of rows in the search.
created_atstringThe datetime when the search was created.
credits_neededintegerThe maximum credits required to download the results. Duplicate searches within a month are not charged.
decision_maker_categorystring | nullThe decision maker category specified during search creation (e.g., "ceo").
file_namestringThe label provided to identify this search.
idstringUnique identifier for this bulk search.
paidbooleanIndicates whether this search was paid for.
started_running_atstring | nullThe datetime when the search started processing.
401Unauthorized
404Not Found

Need Help?

Our team is experienced with APIs and is here to help. Contact us via chat or email at team@anymailfinder.com.