Skip to main content
GET
List the saved searches of a lead

Headers

Authorization
string
required

Bearer [access_token]

Path Parameters

leadId
integer<int64>
required

Query Parameters

source
string

Comma separated origins to keep: AGENT_CREATED, LEAD_CREATED, SYSTEM_CREATED. Defaults to all. System-created searches are usually excluded when migrating, because the target system generates its own and importing ours would duplicate the alerts.

Example:

"AGENT_CREATED,LEAD_CREATED"

includeInactive
boolean
default:false

Include searches whose alerts are switched off. Note that an INSTANTLY cadence is active, not off.

Response

successful operation

id
integer<int64>

Saved search id

Example:

88123456789

leadId
integer<int64>

Id of the lead this search belongs to

Example:

651095960136641

name
string

Name given to the search

Example:

"Cary 3BR under 600k"

source
enum<string>

Who created the search

Available options:
AGENT_CREATED,
LEAD_CREATED,
SYSTEM_CREATED
saleType
enum<string>

Which side of the transaction the search was built for

Available options:
SELLER,
BUYER
status
enum<string>

ACTIVE unless alerts have been switched off for this search

Available options:
ACTIVE,
INACTIVE
alertFrequency
enum<string>

Delivery cadence. INSTANTLY means real time, not disabled

Available options:
NEVER,
TERMINATED,
REFUSED,
INSTANTLY,
DAILY,
WEEKLY,
BIWEEKLY,
MONTHLY
schedule
object

Delivery slots keyed by weekday, AM or PM

Example:
lastSentAt
string

When the last alert email went out, ISO 8601 UTC

Example:

"2026-08-25T13:00:00Z"

createdAt
string

Creation time, ISO 8601 UTC

Example:

"2025-11-02T18:22:31Z"

updatedAt
string

Last update time, ISO 8601 UTC

Example:

"2026-07-14T09:05:12Z"

criteria
object

The search filters

unmappedCriteria
string[]

Names of filters this API version does not model yet. Names only: the values are withheld because the underlying storage mixes in data that is not search intent. Use it to tell a partially understood search from a fully mapped one

hasUnmappedCriteria
boolean

Whether unmappedCriteria is non-empty