Skip to main content
GET
Look up a lead by phone number or email

Authorizations

X-API-KEY
string
header
required

Your API key for authentication.

x-org-id
string
header
required

Org impersonation via x-org-id. Superadmins may impersonate any org; admins may impersonate their direct sub-organizations. Enter the target organization ID to act as that org.

Query Parameters

phone
string<phone> | null

Phone number to search for

email
string<email> | null

Email address to search for

list_id
string | null

Lead list ID to search within

Required string length: 24
campaign_id
string | null

Campaign ID to search within

Required string length: 24

Response

Successful Response

phone
string
required
id
string | null
account_id
string | null
first_name
string | null
last_name
string | null
email
string | null
phone_extension
string | null
call_now
boolean | null
list_ids
string[] | null
timezone
string | null
default:US/Mountain
extracted_data
Extracted Data · object | null
custom_fields
Custom Fields · object | null
preferred_agent_id
string | null
enabled
boolean | null
default:true
created_at
string<date-time> | null
created_by
string | null
campaign_info
CampaignInfo · object[] | null
conversation_seeder_override
Message · object[] | null