RuusterAPI Reference
Menu · Your CRM
Your CRM

Find engaged leads your CRM hasn't called

GEThttps://api.ruuster.com/v1/leads/follow-up

Leads who viewed listings (or engaged more) on your Ruuster sites in a period, whom your CRM shows no call, or no contact of any kind, for N days. Ruuster activity joined with your own CRM, live, in one call. Follow Up Boss.

  • Authentication: x-api-key and x-email headers of an owner or admin
  • Rate limit: lookup call, 20 per minute per key, within the 120 per minute
  • Your CRM: x-crm-vendor and x-crm-key headers with your CRM's API key, used for this request only. See Connect your CRM
  • Rows count against the daily lead-row quota (50,000 by default)
View as Markdown

The follow-up list: "which leads have been looking at homes on our site but haven't been called in the last month?" Ruuster takes every lead with activity in the range, keeps those who meet the engagement level, looks each one up in your CRM by the CRM id Ruuster's CRM sync stored on the lead (crmExternalId), and returns the ones whose last logged call (or, with contact=any, last call, text or email) is older than quietDays, or who were never contacted. Most engaged first.

This call reads your CRM live with your CRM's API key, sent in the x-crm-vendor and x-crm-key headers. The key is used for this request only and never stored. Your CRM answers with its own permissions: an agent's key may see only that agent's people. See Connect your CRM.

Follow Up Boss only for now: Sierra keeps no calls, and Sure Send can't look many people up at once. Other CRMs answer 400 crm_not_supported.

Query parameters

Name Type Default Description
from date 30 days before to First day of Ruuster activity, YYYY-MM-DD in America/Chicago, included. At most 93 days
to date tomorrow Day after the last day, YYYY-MM-DD, excluded. The default includes today
engagement any | viewed | meaningful | strong viewed Who counts as engaged on Ruuster: viewed viewed at least one listing; meaningful 3 or more listing views, or any favorite, tour request, contact-agent click or share; strong a tour request or contact-agent click, 10 or more views, or 2 or more favorites; any any recorded activity
contact call | any call What counts as contact in your CRM: call a logged call; any a logged call, text or email
quietDays integer 30 No contact of that kind in this many days, 1 to 365. Leads never contacted are always included
stage string Only people in this CRM stage (comma-separate several), e.g. Lead,Nurture
pond string Only people in these CRM ponds: a pond id, or a name to match (comma-separate several), e.g. inactive matches every pond whose name contains it
assignedUserId string Only people assigned to this CRM user (an id from Get your CRM's vocabulary)
limit integer 50 Most leads returned, 1 to 500
countOnly 0 | 1 0 1 returns { "total": n, "summary": … } and no rows

Response

data.leads is ordered most engaged first (tour and contact requests, then favorites and shares, then views). Each row:

Field Description
lead The short lead form, as on List active leads
ruuster.level The highest engagement level the lead reached in the range
ruuster.totals Their Ruuster activity in the range: actions, propertyViews, favorites, searches, tourRequests, contactAgentClicks, shares, logins, savedSearchEvents
ruuster.lastActivityAt Their latest recorded activity in the range
crm.personId, name, stage, pond, assignedTo, assignedUserId, tags The person in your CRM
crm.lastCallAt, daysSinceCall The latest logged call, or null if none
crm.lastContactAt, lastContactKind The latest contact of the kind contact asked about (call, text, email or communication)

data.summary counts the funnel: engagedOnRuuster (leads at the level), linkedToCrm (CRM people behind them: leads whose crmExternalId is a CRM person id, one per person), notLinkedToCrm (engaged leads with no CRM id), checkedInCrm, foundInCrm, notFoundInCrm (ids this key doesn't return: deleted, in the trash, merged, or not visible to this key), matchingFilters (with stage, pond or assignedUserId), notContacted and neverContacted. data.criteria restates the rules in words. meta.crm names the CRM, says how many CRM calls were made and carries any caution, such as a key that found few of your leads. Up to the 2,000 most engaged leads linked to your CRM are checked per call.