Quote a list
quote_listWhat this list costs before anyone pays: how many records name a person, and the price by grade.
Pass a saved list (`list_id`, the 8-char id in `#browse?list=<id>`) or an inline
shape (`filters` + `states`; omit `states` for every live state:
CO, CT, FL, NY, TX, VA). You get the same numbers the buy page shows a person:
`matching`, `sellable`, `verified_one`, `verified_both`, `no_channel`, `unnamed`, `facets`, `prices` (the live graded price rule +
`price_rule_version`), `quote` (present when `lane` or `cap` is given),
`exact`, `computed_at`, `quote_valid_until` (counts refresh tomorrow
morning; the quote holds until then), `per_state`, and the `_meta`
provenance block every read carries (schema_version, freshness, source,
access_level). When a count is zero by design the payload adds
`zero_reasons` — a state that never publishes the value, or a channel
asked of records too new to carry one yet: the morning after the
state posts a filing the record carries the name and mailing address;
phone and email are verified when you order. Each reason names the
widened count (`nearest_alternative`, e.g. "last 90 days: 99 with a
phone") and the filters that reach it (`alternative_filters`) — relay it
instead of a silent $0.
**Billing discipline — read before quoting money to anyone.** Only
`sellable` records — matching records whose filing names a person — are
ever billed or delivered. `matching` includes `unnamed` records with no
person to reach; it is never a billable count and must never be presented
as one. Every price line is computed from `sellable` and its grades:
name and address $0.25 per record · plus one verified phone or email $0.50 · plus both $0.70 (price rule v1; live prices always come from the summary call's `prices` block). Lanes: `all` / `best` / `contact` (`all` = every sellable record at the
name-and-address grade; `best` = each record at its own grade, verified
first; `contact` = only records with a verified phone or email — add a
`has_email` filter for emailable now, `has_phone` for callable now). Cap:
`{"type": "count|budget", "value"}` — records for count, cents for
budget. Quote the server's numbers, never arithmetic of your own.
Each `quote.lines[]` entry carries `ships` (what a record at that grade
ships with, in the buyer's words — a name-and-address record never ships a
phone or email), and the summary carries `forecast` ({checked,
phone_expected, email_expected, both_expected, basis, as_of}): how many of
the records still to find on would come back with a verified phone or email,
from our measured outcomes on comparable records — relay it with its basis.
`ceiling_cents` is the most a buyer can be charged: today's total plus the forecast upgrades, charged only for what we find. Every record ships the owner's name and mailing address plus the business facts — the business name, entity type and status, the state filing number and formation date, the industry with its NAICS, SIC and Google Business codes, the registered agent, the Lead Reference, and the Reachability, Contact Relevance and Contact Confidence scores; open the exact file before paying (ten made-up records, every column): https://app.goodleads.club/api/v1/commerce/sample-file?format=xlsx (or format=csv).
The close is two questions: put the quoted choice in front of your human
— callable now (a verified phone), emailable now (a verified email, verified
for deliverability and recent activity), or newest, mail-first — plus a
standing order, then hand over the payment link for the one chosen — per
record, no minimums, so a small first order is the normal first step.
Next: to buy exactly what was quoted, hand the same list / shape, lane and
cap to `checkout_list`.
Args:
list_id: A saved list id. Mutually exclusive with `states` / `filters`.
states: State codes for an inline shape; omit for every live state.
filters: Filter clauses in the one contract (see `list_filterable_fields`).
include_held: Include inactive-or-holding entities (default False).
lane: `all` / `best` / `contact` — asks for a `quote`.
cap: `{"type": "count|budget", "value": <int>}` — the dial the quote
is solved against.
Returns:
The summary contract described above. Keyless callers may not filter
on `contact_name`, `email_primary`, `phone_primary` (422).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cap | No | ||
| lane | No | ||
| states | No | ||
| filters | No | ||
| list_id | No | ||
| include_held | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||