Skip to content

Contacts lookup

Look up one phone number

Query param phone or cellphone. Returns the full releases row in data when found; success: false with no charge when not found.

GET/api/v1/contacts/lookup/phone

Authorization

HeaderTypeRequiredDescription
X-API-KeystringrequiredYour API key, for example lb_live_YOUR_API_KEY. You can send the same key as Authorization: Bearer instead.

Query parameters

NameTypeRequiredDefaultDescription
phonestringrequiredPass this as a query string value.
cellphonestringrequiredPass this as a query string value.

Response

ok boolean
True when the request succeeded.
success boolean
True when this request found a match.
data object
The matched record, or null when nothing matched.
creditsRemaining number
Plan credits left after this request. Null on unlimited plans.