Batch status

API referenceEmail Finder

From the Email Finder API reference. Requests use the base URL https://app.warmerly.com/api/v1 and an API key, see Authentication.

text

GET /email-finder/batches/:id

Returns aggregate progress for a bulk lookup, grouped by job status, for the project in X-Project-Id. A batch id that matches no jobs in that project returns total: 0 rather than a 404.

bash

curl https://app.warmerly.com/api/v1/email-finder/batches/6e6f9d0a-4a3f-4c7e-9c86-1b6a4e5c2f01 \
  -H "X-Api-Key: wmv_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "X-Project-Id: 8f14e45f-ceea-4c6a-8c8d-6b1a5b5c9c1a"

json

{
  "batchId": "6e6f9d0a-4a3f-4c7e-9c86-1b6a4e5c2f01",
  "total": 3,
  "done": 2,
  "pending": 1,
  "counts": {
    "done": 2,
    "scraping": 1
  }
}

done sums jobs in either done or failed status. Use List results with batchId to fetch the actual emails once a batch is complete.

Was this page helpful?

Batch status

More from Email Finder