Find a lead
https://api.ruuster.com/v1/leads/lookupFind your leads by email, phone or CRM id. Returns every match, with links to their activity and emails.
- Authentication:
x-api-keyandx-emailheaders of an owner or admin - Rate limit: lookup call, 20 per minute per key, within the 120 per minute
- Rows count against the daily lead-row quota (50,000 by default)
Only your brokerage's leads are searched.
Query parameters
| Name | Type | Default | Description |
|---|---|---|---|
email |
string | Case-insensitive. Secondary emails are checked when no lead has it as their main email | |
phone |
string | Any format; the last 10 digits are compared. Secondary numbers are checked when no lead has it as their main number | |
crmExternalId |
string | Exact match on the lead's id in your CRM |
Send exactly one of the three, otherwise 400 invalid_parameter. Lookup by email or phone works even when lead contact details are off; the response then leaves out email and phone.
Response
data.leads lists every match. Each has the short lead form (leadId, names, contact details when on, crmExternalId, crmStatus, crmTags, agentId, createdAt, lastLoginAt), plus matchedOn (email, phone or crmExternalId) and links to the lead's activity and emails. More than one record is normal: the same person can be a registered user and a CRM contact, or be with two agents. No match returns an empty list with 200. For Ruuster's verdict on a lead's email address, use
Get a lead's email status.