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
| Header | Type | Required | Description |
|---|---|---|---|
X-API-Key | string | required | Your API key, for example lb_live_YOUR_API_KEY. You can send the same key as Authorization: Bearer instead. |
Query parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
phone | string | required | Pass this as a query string value. | |
cellphone | string | required | Pass this as a query string value. |
Response
okboolean- True when the request succeeded.
successboolean- True when this request found a match.
dataobject- The matched record, or null when nothing matched.
creditsRemainingnumber- Plan credits left after this request. Null on unlimited plans.