View as Markdown

Get Email Verification Results

GET/v2/email-verifications/{id}/results

Read the results of a completed email verification created from data.emails: one item per address in request order (a repeated address at each of its positions), with its status, provider, domain and free_email. Pages of up to 500 (limit, default 100): send metadata.pagination.next_cursor back as cursor until it is null; status keeps one kind of row. Kept until results_expires_at (30 days after completion). A job created in the App answers 409 results_unavailable: its output is result_files. Free; a poll (0 rate-limit units, per-second window only).

Path parameters

  • idstringrequired

    The verification job id: the id that POST /v2/email-verifications answers and GET /v2/email-verifications lists.

Query parameters

  • cursorstringoptional

    Opaque cursor: metadata.pagination.next_cursor of the previous page. Absent for the first page; the last page answers next_cursor: null.

  • limitintegeroptionalmin: 1max: 500default: 100

    Rows per page.

  • statusenumoptional

    Only the rows with this result status.

    Allowed values: valid invalid accept_all unknown

Responses

  • 200 One page of results.
  • 400 A malformed id (VALIDATION_ERROR, no code), a malformed query, or a cursor no page handed out (VALIDATION_ERROR; payload.code says which kind of mistake).
  • 401 Missing, unknown or inactive credentials (UNAUTHORIZED).
  • 404 No such record in this workspace (NOT_FOUND).
  • 409 CONFLICT: the job is not completed yet (invalid_state, payload.status names its state), or it was created in the App, whose output is result_files (results_unavailable).
  • 410 The results were removed at results_expires_at (GONE, results_expired).
  • 429 Over the poll rate limit (RATE_LIMIT); wait Retry-After seconds. Sent only where rate limits are enforced for the caller channel.
  • 500 Unexpected server error.

For error handling see Errors.