ConnfigConnfig Docs
Tool Reference

Lead Generation Tools

Tools for starting, monitoring, and reading Google Maps lead-scraping jobs

This domain contains 5 tools for Google Maps-based lead generation. The typical flow: start a job with start_scrape, track it with get_scrape_status, then read the results with list_leads and get_lead.

start_scrape consumes your monthly lead quota, and only one scrape can run at a time per account. Use get_workspace_usage to check your remaining quota.

Tools

start_scrape

Starts a Google Maps lead-scraping job. The job runs asynchronously — poll it with get_scrape_status. It consumes the workspace owner's monthly lead quota and incurs scraping cost. Person-level enrichment options require a Pro or Team plan.

Key parameters:

ParameterTypeRequiredPurpose
workspace_idstring (UUID)YesWorkspace ID
search_termsarray of strings (1–5)YesSearch queries, e.g. ["dentist", "dental clinic"]
countrystringYesCountry name, e.g. "Turkey"
country_codestring (2 letters)NoISO country code, e.g. "tr"
citystringNoCity filter
statestringNoState/region filter
languagestringNoResult language, e.g. "en" or "tr" (default "en")
results_per_termnumber (1–6000)NoResults per search term (default 10)
place_minimum_starsenumNoMinimum rating: all, two, twoAndHalf, three, threeAndHalf, four, fourAndHalf (default all)
maximum_leads_enrichment_recordsnumber (1–10)NoEnables person-level enrichment (Pro/Team only)
leads_enrichment_departmentsarray of enumsNoDepartments to enrich, e.g. sales, marketing, c_suite

Prompt your AI like this: "Find dental clinics in Ankara, 100 is enough. Only places rated 4 stars or above."

get_scrape_status

Returns the current status of one scrape job (pending, running, completed, failed) with its result count. Poll this after start_scrape.

Key parameters:

ParameterTypeRequiredPurpose
workspace_idstring (UUID)YesWorkspace ID
scrape_job_idstring (UUID)YesThe job ID returned by start_scrape

Prompt your AI like this: "Is the scrape we started earlier done yet? Check its status."

list_scrape_jobs

Lists a workspace's recent lead-scraping jobs with status and result counts.

Key parameters:

ParameterTypeRequiredPurpose
workspace_idstring (UUID)YesWorkspace ID
statusenumNopending, running, completed, failed
limitnumber (1–200)NoMax rows to return (default 50)
offsetnumberNoRows to skip (pagination)

Prompt your AI like this: "Show my recent scrape jobs and how many results each brought in."

list_leads

Paginated lead list for a workspace (scraped Google Maps places). Filters: free-text search on business name, city, category, has-email, and favorites. Archived leads are excluded unless include_archived is set.

Key parameters:

ParameterTypeRequiredPurpose
workspace_idstring (UUID)YesWorkspace ID
searchstringNoMatches the business name
citystringNoCity filter
categorystringNoCategory filter
has_emailbooleanNoOnly leads with at least one email
favorites_onlybooleanNoFavorites only
include_archivedbooleanNoInclude archived leads (default false)
limit / offsetnumberNoPagination (limit defaults to 50, max 200)

Prompt your AI like this: "List my Ankara leads that have an email address."

get_lead

Returns the full detail of a single lead: contact info, social profiles, scores, enrichment data, and workspace-level status fields.

Key parameters:

ParameterTypeRequiredPurpose
workspace_idstring (UUID)YesWorkspace ID
lead_idstringYesLead row ID (as returned by list_leads)

Prompt your AI like this: "Show me everything you have on the 'Dentalya Clinic' lead."

To update lead notes and statuses, see Data Pool Tools. To move a lead into the CRM, see promote_lead_to_crm in CRM Write Tools.