RuusterAPI Reference
Menu · Leads
Leads

List leads

GEThttps://api.ruuster.com/v1/leads

Your brokerage's leads, filtered by when they were created, updated or last active. Paged.

  • 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
  • Rows count against the daily lead-row quota (50,000 by default)
View as Markdown

Query parameters

Name Type Default Description
dateField string created Which date from and to filter on: created, active (any recorded activity in the range) or updated
from date First day, YYYY-MM-DD, included. No date filter when omitted, except active, which defaults to the last 30 days
to date Day after the last day, YYYY-MM-DD, excluded
type string all user (has a Ruuster account), unregistered (CRM-only contact) or all
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 a list of lead objects; meta.total and meta.nextCursor page through them. Rows count against your daily lead-row quota.

Lead object

Field Description
leadId user:<uuid> (has a Ruuster account) or unregistered:<uuid> (a contact synced from your CRM). Use the whole value
firstName, lastName
email, phone Only when lead contact details are on for your brokerage (see leadContactDetails in /me)
crmExternalId The lead's id in your CRM, for example the Follow Up Boss person id
crmStatus, crmTags From your CRM. crmStatus can be empty for CRM-only contacts
agentId The lead's assigned agent. Look it up with Get an agent
source First recorded visit, when known: utmSource, utmMedium, utmCampaign, firstSeenAt
createdAt, createdAtInCrm When Ruuster first saw the lead, and when your CRM did
lastLoginAt, lastActivityAt, updatedAt