Look up an email address by URL
GET
/v1/lookup/email/{address}
curl -X GET "https://us1.platform.bird.com/v1/lookup/email/{address}" \
-H "Authorization: Bearer $TOKEN"The same lookup as Look up an email address, with the address in the URL instead of the body.
Returns whether the address will accept mail, how confident that is, why not when it will not, its characteristics, and the correction when it looks like a misspelling. result and reason are open vocabularies, so treat a value you do not recognize as a future one rather than an error.
Two differences from the POST form are worth knowing before you choose it. The address appears in the URL, so it will be recorded wherever request URLs are (proxies, access logs, browser history), which is why the POST form exists. And this form takes no Idempotency-Key, so a retry is a second lookup and is billed again.
Parametri
address
string
The email address to look up. Percent-encode it, because a local part may legally contain characters a URL path reads as structure. The @ itself is safe either way.
Payload di risposta
email
string
obbligatorio
The address that was looked up, exactly as you sent it.
valid
boolean
obbligatorio
Whether the address is well-formed and its domain is set up to receive mail at all. It says nothing about the mailbox itself, so a valid domain with no such mailbox is true here and undeliverable in result.
result
object
obbligatorio
delivery_confidence
integer
obbligatorio
How likely mail to this address is to be delivered, from 0 (certain not to be) to 100 (certain to be). Read it alongside result rather than instead of it, because the same score can sit under neutral or risky for different reasons.
flags
array of string
obbligatorio
Notable characteristics of the address. Empty when none apply.
reason
object
Why the address cannot receive mail. Absent unless result is undeliverable.
did_you_mean
string
The address this one looks like a misspelling of. Absent unless a correction was found, which in practice means result is typo. Offer it to whoever typed the original rather than sending to it unasked, because it is a guess and the address they meant may be neither one.