Skip to content

API reference/bulk

Download a bulk job's results as CSV

GET/api/v1/email/bulk/{jobId}/results

authentication
Secret API key as a bearer token
billing
Free.

Streams the run's result file: a finished job's full results, or the partial file a mid-run cancellation kept. The file starts with the input's own columns (for an API list, a single email column; for a dashboard upload, every column of the uploaded file), followed by verified_email and the verdict fields, one row per input row in the original order:

verified_email, deliverable, reason, risk_score, risk_level, risk_signals, normalized_email, is_alias, is_gibberish, looks_generated, local_part_pattern, first_name, last_name, disposable, is_relay, relay_service, role, role_type, free_provider, domain_category, mx_found, mx_implicit, mx_provider, mx_provider_type, mx_blocklisted, mx_network_type, has_spf, dmarc_policy, domain_registered_at, domain_age_days, domain_expires_at, parked, smtp_checked, smtp_checked_at, mailbox_exists, previously_invalid, previously_invalid_at, catch_all, smtp_reason, mailbox_confidence, widely_seen, did_you_mean, ok_to_send, blocked_by, credits_used, cache_hit, suppressed

Add ?variant=deliverable (or risky, undeliverable) to download only those rows. A job still running answers 409 RESULTS_NOT_READY; one cancelled before any address was processed answers 409 JOB_CANCELLED, and one that failed before any address was processed 409 JOB_FAILED. A run that was cancelled or failed part-way keeps the rows it did write, and they stay downloadable.

format=json answers the same rows, filtered the same way, as objects keyed by the result file's own header instead of a CSV attachment: { "success": true, "data": { "job": …, "results": [ … ] }, "meta": { "variant", "request_id" } }. It is streamed row by row exactly as the CSV is, so a 100,000-row run costs no more to answer either way. A CSV cell carries no type, so only the two the writer encodes come back typed: an empty cell is null and true/false are booleans. Everything else is the string as written — a number is never silently made numeric, because postcodes, phone numbers and house numbers lose their leading zeros that way — and the columns of an uploaded file come back exactly as they were uploaded.

Parameters

name in type description
jobIdrequiredpathintegerThe id returned at creation.
variantquerystringWhich rows to include. One of: full, deliverable, risky, undeliverable. Default: full.
formatquerystring`csv` streams the file as an attachment; `json` streams the same rows as objects. One of: csv, json. Default: csv.

Example request

curl https://spaw.co/api/v1/email/bulk/512/results \
  -H "Authorization: Bearer sk_live_…"
const response = await fetch('https://spaw.co/api/v1/email/bulk/512/results', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer sk_live_…',
  },
});
const result = await response.json();
import requests

response = requests.get(
    'https://spaw.co/api/v1/email/bulk/512/results',
    headers={'Authorization': 'Bearer sk_live_…'},
)
result = response.json()
$ch = curl_init('https://spaw.co/api/v1/email/bulk/512/results');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['Authorization: Bearer sk_live_…'],
]);
$result = json_decode(curl_exec($ch), true);
from spaw import Client

client = Client('sk_live_…')
result = client.download_bulk_results(512)
import Spaw from 'spaw';

const spaw = new Spaw({ apiKey: 'sk_live_…' });
const result = await spaw.downloadBulkResults(512);
use Spaw\Client;

$spaw = new Client('sk_live_…');
$result = $spaw->downloadBulkResults(512);

This endpoint has no console on its page. It answers with records from your own account, often by an id only you have, rather than about a value you can type here. The dashboard lists the same rows.

Responses

200The result rows: a CSV attachment named `spaw-bulk-{jobId}.csv` (with `-{variant}` appended for a filtered download), or streamed JSON with `format=json`.

email,verified_email,deliverable,reason,risk_score,risk_level,risk_signals,normalized_email,is_alias,is_gibberish,looks_generated,local_part_pattern,first_name,last_name,disposable,is_relay,relay_service,role,role_type,free_provider,domain_category,mx_found,mx_implicit,mx_provider,mx_provider_type,mx_blocklisted,mx_network_type,has_spf,dmarc_policy,domain_registered_at,domain_age_days,domain_expires_at,parked,smtp_checked,smtp_checked_at,mailbox_exists,previously_invalid,previously_invalid_at,catch_all,smtp_reason,mailbox_confidence,widely_seen,did_you_mean,ok_to_send,blocked_by,credits_used,cache_hit,suppressed
[email protected],[email protected],deliverable,,0,low,,[email protected],false,false,false,first,mia,,false,false,,false,,false,other,true,false,google,mailbox_provider,false,hosting,true,reject,1998-03-12,10402,2027-03-12,false,true,2026-09-03T10:12:44+00:00,true,false,,false,,,false,,true,,1,false,false

401The key is missing, malformed, or revoked.

{
    "success": false,
    "error": {
        "code": "UNAUTHENTICATED",
        "message": "Provide a valid API key as a bearer token.",
        "request_id": "req_01m1kgdm4xngzmbmff68g94w0c"
    }
}

404No such record on this account.

{
    "success": false,
    "error": {
        "code": "NOT_FOUND",
        "message": "No record with that id on this account.",
        "request_id": "req_01m1kgdm4xngzmbmff68g94w0c"
    }
}

409The results are not available yet (`RESULTS_NOT_READY`) or never will be (`JOB_CANCELLED`, `JOB_FAILED`).

{
    "success": false,
    "error": {
        "code": "RESULTS_NOT_READY",
        "message": "The job has not finished yet. Poll its status until it reports completed.",
        "request_id": "req_01m1kgdm4xngzmbmff68g94w0c"
    }
}

422The `variant` query parameter is not one of the allowed values.

{
    "success": false,
    "error": {
        "code": "VALIDATION_FAILED",
        "message": "variant must be one of: full, deliverable, risky, undeliverable.",
        "request_id": "req_01m1kgdm4xngzmbmff68g94w0c"
    }
}

429Over 5 requests per second for the key. Retry after the limit resets.

{
    "success": false,
    "error": {
        "code": "RATE_LIMITED",
        "message": "Too many requests. Retry after the limit resets.",
        "request_id": "req_01m1kgdm4xngzmbmff68g94w0c"
    }
}

Error codes

Failures answer { success: false, error: { code, message, request_id } }. Each code has its own page.

markdown version·openapi.json