get_pricing_terms
GroundQuote pricing terms
Read this first and relay it to the contractor before creating an account. Returns the plain-language pricing disclosure ($5 browsing lead, $15 high-intent lead, optional $150/month unlimited; nothing charged until the contractor unlocks a lead) and the guarantees. No inputs.
Takes no parameters.
get_install_instructions
How to install GroundQuote
Explains the two install paths (iframe embed on an existing site, or a GroundQuote-hosted page for contractors with no site), what works with AI site builders, and how account ownership works. Use before you promise the contractor anything about the install.
Takes no parameters.
create_contractor_account
Create a contractor account
Creates a GroundQuote account for a fence contractor and emails the contractor a link to set their own password (the email includes the pricing terms). Nothing is charged; no card is required. Returns org_id, slug, the embed snippet, terms_summary, and a setup_claim you must keep and pass to set_fence_pricing, set_branding, set_hosted_page, get_embed_code, check_account_status and resend_setup_email. Confirm the contractor has heard the pricing terms before calling. Use the contractor's own email as owner_email.
Parameterscityphonerequiredstateowner_namerequiredowner_emailrequiredwebsite_urlcompany_namerequiredterms_relayedrequired
set_fence_pricing
Set the contractor's fence pricing
Loads the contractor's price list. Rates are dollars per linear foot by material, then style, then height ("4 ft", "6 ft", "8 ft"). Gates are flat surcharges. Ask the contractor for real numbers; never invent them. Replaces the whole fence catalog each call. Requires org_id and setup_claim from create_contractor_account.
Parametersfencesrequiredorg_idrequiredsetup_claimrequiredrequire_phonegate_double_usdgate_single_usdremoval_per_ft_usd
set_rental_pricing
Set temporary fence RENTAL pricing
For fence RENTAL companies (construction sites, events, security) rather than installers. Loads rental products priced in dollars per linear foot per period (day / week / month), the minimum term, per-rental gate charges, delivery and setup fees and optional add-ons (privacy screen, sandbag bases). Enables the rental option on the widget; leaves any installed-fence catalog untouched. Ask the company for real numbers; never invent them. Requires org_id and setup_claim from create_contractor_account.
Parametersaddonsorg_idrequiredproductsrequiredrental_onlysetup_claimrequiredmin_term_dayssetup_fee_usdwalk_gate_usddrive_gate_usdsetup_fee_unitpanel_length_ftdelivery_fee_usd
set_branding
Match the widget to the contractor's brand
Sets logo, colors and font on the quote widget. Pass auto_fetch_from_url to read the logo and primary color from the contractor's existing site; explicit fields win over fetched values. Requires org_id and setup_claim.
Parametersfontorg_idrequiredlogo_urlsetup_claimrequiredwebsite_urlaccent_colorprimary_colorsecondary_colorauto_fetch_from_url
set_hosted_page
Enable the hosted quote page
For contractors without a website: turns on a branded page at groundquote.com/{slug} with headline, services and contact details. Requires org_id and setup_claim.
Parameterscityemailphonestateorg_idrequiredenabledheadlineservicescover_urlsubheadingsetup_claimrequired
get_embed_code
Get the embed snippet
Returns the iframe HTML to paste into the contractor's site and the hosted-page URL. Requires org_id and setup_claim.
Parametersorg_idrequiredsetup_claimrequired
check_account_status
Check account status
Shows whether the contractor has set their password yet (setup_link_pending), the current pricing summary, branding and install details. Requires org_id and setup_claim.
Parametersorg_idrequiredsetup_claimrequired
resend_setup_email
Resend the set-password email
Re-sends the contractor's set-password email (max 3 per day per account). Requires org_id and setup_claim.
Parametersorg_idrequiredsetup_claimrequired
find_fence_contractors
Find fence contractors near a homeowner
For homeowners looking for a fence. Lists verified fence contractors (businesses that have confirmed their contact details with GroundQuote) near a US ZIP or city, in two groups, each contractor only within their own service radius: instant_quote (GroundQuote contractors with published rates — use contractor_id with get_fence_estimate) and listed_only (verified directory contractors without published rates — share their directory link or phone; do not invent prices). unverified_nearby counts other directory contractors who have not verified yet and are not listed; browse_directory_url is the public directory page for the area, to share when the homeowner wants more choice or nothing verified is nearby. Free for homeowners.
Parameterszipcitystatematerial
get_fence_estimate
Price a fence from a contractor's own rates
Returns a price range for a fence from one GroundQuote contractor's published per-foot rates, gates and removal fee. Nothing is sent to the contractor. If the material/style/height is not offered, returns that contractor's options. Tell the homeowner it is an estimate until the contractor measures on site.
Parametersstyleheightmaterialrequiredlinear_feetrequireddouble_gatessingle_gatescontractor_idrequiredremove_old_fence
send_quote_request
Send the homeowner's request to a contractor
Sends the homeowner's name, email, phone, address and fence details to ONE GroundQuote contractor. Only call after the homeowner has explicitly agreed to share these details with that contractor. wants_site_visit=true asks the contractor to call and arrange a measurement visit; false is a price inquiry. The contractor contacts the homeowner directly; GroundQuote does not email or text the homeowner and never charges them. Repeat calls for the same homeowner and contractor within a day return the same request.
Parametersnotesprojectrequiredhomeownerrequiredcontractor_idrequiredpreferred_dayspreferred_timewants_site_visitrequiredhomeowner_consentrequired
open_quote_map
Let the homeowner draw their fence on a map
Opens one GroundQuote contractor's interactive satellite map inside the chat. The homeowner finds their property, draws the fence line, picks material and height, and sees that contractor's price from measured footage; if they choose, they send their details or book a site visit right in the map (the same lead the contractor gets from their website: $5 browsing, $15 with a visit, billed to the contractor only on unlock). Prefer this over get_fence_estimate when the homeowner is able to draw. Use a contractor_id from the instant_quote group of find_fence_contractors. GroundQuote does not email or text the homeowner; the contractor contacts them.
Parameterscontractor_idrequired
search
Search GroundQuote documentation
Searches GroundQuote's documentation (what it is, pricing, install, ownership, pricing format, rules for assistants). Returns ids to pass to fetch.
Parametersqueryrequired
fetch
Fetch a documentation page
Returns the full text of a documentation entry by id from search.
Parametersidrequired