validation/batches_by_id
Tool: read
Get validation batch progress and aggregate result counts.
status is InProgress until every queued item has a result, then Completed (completedAt
stays null while running). items[] carries the per-email outcome; aggregate counts live in
results. Poll this operation after validation/post_emails —
validation is asynchronous and not instant. Once Completed, act on the outcomes: each prospect's
validationStatus is filterable via prospect/get — full recipe in
guides/validating-emails.
Arguments
| name | type | req | notes |
|---|---|---|---|
| batchId | string | ✓ | uuid — from the validation/post_emails response |
Response
200 — Validation batch status.
| field | type | description |
|---|---|---|
| batchId | string | Validation batch id (uuid). |
| status | string | InProgress or Completed. |
| source | string | Batch source: api, crm_bulk, or campaign_auto. |
| submitted | integer | Total input items submitted. |
| queued | integer | Prospects queued for validation. |
| completed | integer | Validation items completed so far. |
| completedJobs | integer | Completed platform sub-jobs. |
| totalJobs | integer | Total platform sub-jobs in this batch. |
| results | object | Aggregate counts: valid, invalid, catchAll, disposable, unknown, unvalidated. |
| skipped | object | Items skipped before validation (recentlyValidated, duplicate). |
| dataTokensSpent | integer | Data Tokens charged for this batch so far. |
| items[] | array | Per-email validation status. |
| items[].prospectId | integer | Prospect id created or used for validation. |
| items[].email | string | Email address submitted. |
| items[].validationStatus | string | One of: Unvalidated, Valid, Invalid, CatchAll, Disposable, Unknown. |
| items[].validatedAt | string | When last validated; null while in progress or never validated. |
| items[].inProgress | boolean | True while still awaiting the validation result. |
| createdAt | string | Batch creation timestamp (UTC). |
| completedAt | string | Batch completion timestamp (UTC); null while running. |
Errors: 400, 401, 403, 406, 422, 429, 500 — shared schema: schemas/errors.
Invoke
Call read with name: "validation/batches_by_id".