Skip to main content
GET
Get Bulk Email Enrichment Status and Results
Poll the status of a previously submitted bulk enrichment batch. The response uses the same envelope shape as single-request polling and webhooks, with multiple items in the data array. Track progress by comparing completed_count to total.

Path parameters

string
required
The batch ID returned by POST /api/v1/email/bulk.

Header parameters

string
required
Bearer <your_api_key>
string
Optional alternative to the Authorization Bearer scheme. Your API key sent as a header.

Request example

Response

object
required
Batch metadata.
object | null
Webhook configuration and delivery status. null when no webhook was provided at submission.
object | null
The exact JSON object you provided in the submission request.
object | null
Credit usage for this response.
object[]
required
Array of per-request results for every NPI in the batch.

Status values

Example response

Errors

  • Missing or invalid API keys are rejected.
  • 403: Revoked or inactive API key.
  • 422: Validation error, with a response body like:

Tips

  • There is no pagination on this endpoint. The data array contains all requests in the batch.
  • Compare completed_count to total to know when the entire batch is done.
  • Use webhooks as your primary notification mechanism and poll only as a fallback if a webhook does not arrive.
  • Dedupe updates by request_id so replays and retries do not create duplicate records in your system.