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

Parameter	Example value	Description
`searchId` string	`"blk_123a4b5c"`	The unique identifier of the bulk search.

Response

200OK

Show less

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": "finance,ceo",
  "file_name": "string",
  "id": "string",
  "paid": true,
  "started_running_at": "2025-01-08T13:25:36.457Z",
  "status": "queued"
}

Property	Type	Description
`status`	string	The 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.failed`	integer	Number of rows where the search failed.
`counts.found_unknown`	integer	Number of rows with risky emails found.
`counts.found_valid`	integer	Number of rows with valid emails found.
`counts.not_found`	integer	Number of rows where no email was found.
`counts.total`	integer	Total number of rows in the search.
`created_at`	string	The datetime when the search was created.
`credits_needed`	integer	The maximum credits required to download the results. Duplicate searches within a month are not charged.
`decision_maker_category`	string \| null	The decision maker categories specified during search creation. This is a comma-separated list.
`file_name`	string	The label provided to identify this search.
`id`	string	Unique identifier for this bulk search.
`paid`	boolean	Indicates whether this search was paid for.
`started_running_at`	string \| null	The datetime when the search started processing.

401Unauthorized

404Not Found

Need Help?

Our team is experienced with APIs and is here to help.
Chat with us.