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

ID of the lead whose saved searches to list.

Required range: x >= 1

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

Success. A request rejected by validation or by a business rule also answers HTTP 200, with {"code": <error code>, "message": "..."} in place of the result: check code in the body, not the HTTP status. Codes are listed under Errors in the Saved Searches section.

savedSearches
object[]

The lead's saved searches