Skip to content

Create Saved Search

Store a set of filters to re-run later.

POST/api/v1/lead-finder/saved-searches

Requires an API key with the write scope.

Body Parameters#

namestringbodyrequired
Name, 1 to 200 characters.
kindstringbodyrequired
people or companies.
filtersobjectbody
The filters, with the keys returned by Get Filter Options.

Response#

Returns the saved search with a 201 status code.

dataobject
Show data
idstring
Saved search identifier.
namestring
Name.
kindstring
people or companies.
filtersobject
The stored filter object.
lastRunAtstring
ISO 8601 timestamp of the last run, or null.
lastTotalinteger
Result count from the last run, or null.
alertEnabledboolean
Whether alerts are on for this search.
createdAtstring
ISO 8601 timestamp.

Errors#

StatusDescription
401Missing, invalid, revoked or expired API key
403API key does not have the required scope: write
404Lead Finder is not enabled while Lead Finder is switched off on this environment
503Lead Finder is not configured when it is enabled but has no data provider key
422name is empty or kind is not people or companies

Rate Limit#

  • 120 requests per minute, shared by every write call in your workspace. Fixed 60-second window.
  • Every response includes X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset (unix epoch seconds) and X-RateLimit-Bucket (write).
  • A 429 response includes a Retry-After header (seconds until the bucket resets).

For client-side patterns, see Rate Limiting.

Was this page helpful?
View as MarkdownLast updated November 4, 2026