Query saved leads with the full filter set

The richer sibling of /api/v1/results. Accepts the same 129 filter parameters the web app uses (enrolled among them), including relevance, email verification state, enrichment status, platform detections (cmsPlatform, crmPlatform, chatWidget, bookingSystem, emailMarketingPlatform), payments on the site (paymentProvider, excludePaymentProvider: a name such as Square, a group such as group:aggregator or group:high-risk, or none), what the site says (merchantSignal, excludeMerchantSignal: a statement or a group such as group:restricted), merchant-services views (merchantView, e.g. restricted-on-aggregator or chargeback-prone), data freshness, and change signals (signal + signalWindow). Every name, group and view is listed at GET /api/merchant-vocabulary. Multi-select filters are sent as a repeated query key. Use POST with a JSON body when the filter set is too large for a query string. Costs nothing: this reads leads you already own.

get/api/v1/leads

Request

  • Base URL: https://lyreleads.com
  • URL: https://lyreleads.com/api/v1/leads
  • Auth: HTTP bearer

Query parameters

pageinteger
limitinteger
querystring

Search keyword the lead was found under. Repeatable.

citystring

Repeatable.

typestring

Google Maps category. Repeatable.

relevanceYesboolean

Only rows a model judged to be the business the query asked for.

hasVerifiedEmailboolean
hasContactEmailboolean

Has a named contact email on file. hasDecisionMakerEmail is still accepted and means the same thing.

enrichmentStatusstring

enriched | pending | failed | unverifiable | no_website. Repeatable.

enrolledboolean

true = enrolled in enrichment (re-checked about monthly, paid once). false = not enrolled. Each lead carries enrichment_enrolled_at, null when not enrolled.

signalstring

Change-signal key from GET /api/v1/signals/catalog. Repeatable.

signalWindowstring

Lookback in days for signal: 7, 30 or 90.

Response

Paginated leads with total count

Changes

No recorded changes to this operation across all 1 revision of this API.