Leads
List active leads
GET
https://api.ruuster.com/v1/leads/activityYour leads with recorded activity in a period, most active first. The hot list for follow-up.
- Authentication:
x-api-keyandx-emailheaders of an owner or admin - Rate limit: 120 requests per minute per key
- Rows count against the daily lead-row quota (50,000 by default)
One row per lead with any recorded activity on your sites in the range, ranked by how much they did. Use it to find who to call this week; use Get a lead's activity for one lead's day-by-day detail.
Query parameters
| Name | Type | Default | Description |
|---|---|---|---|
from |
date | 7 days before to |
First day, YYYY-MM-DD in America/Chicago, included |
to |
date | today | Day after the last day, YYYY-MM-DD, excluded |
minActions |
integer | 1 |
Only leads with at least this many actions in the range |
cursor |
string | meta.nextCursor from the previous page. Omit for the first page |
|
limit |
integer | 100 |
Rows per page, 1 to 200 |
countOnly |
0 | 1 |
0 |
1 returns { "total": n } and no rows |
Response
data.leads is ordered by totals.actions, highest first, then by leadId. Each row:
| Field | Description |
|---|---|
lead |
The short lead form: leadId, firstName, lastName, email and phone when lead contact details are on, crmExternalId, crmStatus, crmTags, agentId, createdAt, lastLoginAt |
totals.actions |
Recorded activities in the range: listing views, searches, favorites, saved-search changes, tour and contact requests, sign-ins and shares |
totals.propertyViews, favorites, savedSearchEvents, searches, tourRequests, contactAgentClicks, logins, shares |
The breakdown |
firstActivityAt, lastActivityAt |
First and last recorded activity in the range |
Email opens and clicks aren't part of this ranking; they're on Get a lead's activity and List a lead's emails. Rows count against your daily lead-row quota. meta.coverage says which days of activity are available; a range that reaches before coverage.from ranks on the covered days only.