leads
leads

Geo Shortcuts

Top MSAs + cities by lead count for the Map View's state-aware chips.

Replaces the hardcoded "Tampa Bay / Miami / Orlando / Jacksonville" chips from PR #305 — those made no sense once a buyer switched to a non-FL state. This endpoint returns the actual top territories by inventory, with counts that the chip labels surface so the buyer sees "New York metro · 8.4K" instead of guessing.

Each shortcut item is the same {field, op, value} shape as the rest of the filter system, plus label (chip display text) and count (entities matching that filter under the current sellable predicate).

Cached for 5 minutes — top-MSA distributions move slowly and the aggregation is the same for every buyer on the same state.

get/api/v1/leads/geo-shortcuts

Request

  • Base URL: https://app.goodleads.club (the document declares no server; this is the origin it was published from)
  • URL: https://app.goodleads.club/api/v1/leads/geo-shortcuts
  • Auth: none declared

Query parameters

statestring required

State code (e.g. FL, NY, CO, VA)

include_non_operatingboolean

Mirror the /leads/geo semantics — sellable-only counts by default.

include_existingboolean

Include existing businesses with a new filing: companies opening a location here, local owners who formed their company in another state, businesses back in business, established businesses under a new entity, moved, or with a new trade name. Default False — Just started only (a brand-new business), matching every file sold as new businesses. Naming a filing_kind in filters implies it.

include_registrationsboolean

Deprecated alias of include_existing (kept one release so saved links resolve).

Response

Successful Response

unknown required

Changes

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