BObounceless

Get batch verification results.

Results are readable while processing. Prefer cursor pagination: start without cursor, then pass each non-null nextCursor unchanged. Keep collecting while countsMayChange is true; after the request becomes terminal, start one final cursor walk from the beginning and de-duplicate by email to obtain the settled snapshot. offset remains supported for compatibility but is not recommended. A malformed cursor returns 400. Optional state, resultCategory and q filters narrow the walk server-side before pagination; keep them unchanged while following nextCursor. state preserves the initial outcome; resultCategory groups completed catch-all resolutions into deliverable, undeliverable or risky. Unknown filter values or a q longer than 200 characters return 400.

get/v1/requests/{id}/results

Request

  • Base URL
    https://api.bounceless.io
  • Auth
    API key in header X-Api-Key

Path parameters

idstring uuid required

Query parameters

limitinteger
cursorstring

Opaque continuation token returned as nextCursor. Do not decode or modify it. When present, cursor takes precedence over offset.

offsetinteger

Compatibility pagination. Prefer cursor/nextCursor.

statestring

Comma-separated list of presented row states (the state field of each result). recheck selects retry-exhausted rows, which never match their stored state.

resultCategorystring

Comma-separated final result categories: deliverable, catch_all, unknown, undeliverable, risky, recheck, pending, other. Combines with state and literal q; unresolved, pending or failed catch-all resolutions remain catch_all.

qstring

Case-insensitive literal substring of the address.

order'asc' | 'desc'

Row order. asc (default) is oldest-first and is the only order cursor pagination walks. desc returns the newest rows first as a live tail read: nextCursor is always null and combining it with cursor returns 400.

Response

Paginated results.

jobIdstring uuid required
limitinteger required
offsetinteger required

Compatibility echo; ignore when traversing with cursor.

nextCursorstring nullable required

Pass a non-null value as the next cursor query parameter. null terminates this walk.

partialboolean required

true until a successful finalized snapshot exists.

finalizedboolean required
countsMayChangeboolean required

When true, more rows or changed counters may appear while the job runs.

requestIdstring required

Changes

No recorded changes to this operation across all 1 revision of this API.