Queue a building permit CSV export
create_permit_exportQueues a CSV of building permits from exactly one source: a saved permit alert (alertId, palr_…; alertScope picks not_dismissed (the default), pending, saved (kept), dismissed, or all), a list (listId), permitIds already in hand (at most 10,000), or a new filter set (at most 10,000 permits). Filters cannot be combined with an alert, list, or ids; to narrow one, pull its permits with the narrowing filters first and export those permitIds. Every row has Latitude, Longitude, and Location Precision columns for loading into a map. deliveryMode="new" leaves out permits already delivered, including ones already read in this chat. The response is a receipt with exportJobId, never the CSV bytes. Queuing does not use credits; new or changed rows count toward 100,000 export records a month on County, State, and National, and cost 1 credit each on API Only and the trial. Rows already delivered unchanged are not charged again. Permit contacts are in the file. count_permits returns the match count for a new filter set. get_export returns status, and the file downloads from https://boardwalkai.com/exports.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "create_permit_export"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Same as the permits map search box: words from the permit (work description, address, names) or a permit number. One search text, not a list: for several alternative terms, make one call per term. Use one of q, permitNumber, or contractor per call. | |
| ids | No | Alias of permitIds. | |
| bbox | No | Map area as "west,south,east,north" or {west,south,east,north}. Around a planned project, search q with its street address first; use a small box around its coordinates only when it has no address, and say which permits are at neighbouring addresses. | |
| cities | No | Region: city ids or names ("Lehi"). A permit in any listed state, county, or city matches, so do not add the county. A name that matches several cities is refused with each candidate's id and state: pass the id, or add the state (states:["UT"]), which then only helps find the city. | |
| dateTo | No | Window end, YYYY-MM-DD, inclusive. | |
| listId | No | Export the permits saved on this list ("lst_…"). Not with filters. | |
| stages | No | Status stage as "<status>:<stage>" or "bucket:<status>"; get_permit_reference facet "stages" lists them. | |
| states | No | Region: state ids, names, or abbreviations ("UT"). states, counties, and cities are one Region filter: a permit in any of them matches. Send only the narrowest place, never "UT" together with "Utah County". | |
| trades | No | Trades the job involves (the scope of the work, not open bids): site_work, foundation, paving_concrete, framing, roofing, windows_doors, siding_exterior, insulation, electrical, plumbing, hvac, gas, fire_protection, low_voltage, solar, elevator, drywall, flooring, cabinets_countertops, finish_carpentry, painting, appliances, cleaning, landscaping, fencing, pool. roofing here also matches new homes and additions with roof work; workTypes roofing is re-roof jobs only. When a trade rep asks for "roofing permits", count both and say which is which. | |
| whyNow | No | Why now codes: issued_no_inspections, rough_in_passed, finals_next, last_inspection_failed, on_hold, fees_due, slow_review, new_owner, expiring_soon. | |
| alertId | No | Export the permits on this permit alert ("palr_…"). Not with filters. | |
| sectors | No | Private or public work. Default both. | |
| sqftMax | No | Square feet maximum. | |
| sqftMin | No | Square feet minimum. | |
| counties | No | Region: county ids or names ("Utah County"). Names that match more than one place are refused, not guessed; the refusal lists each candidate's id and state. A permit in any listed state, county, or city matches. A state sent with a county inside it only helps find the county (warning region_parent_state_dropped). | |
| dateFrom | No | Window start, YYYY-MM-DD, inclusive. | |
| filename | No | Optional file name, 1–120 characters. | |
| jobKinds | No | Major or minor jobs. Default both; "major" alone leaves out small jobs such as a water heater swap. | |
| placeKey | No | placeKey from a permit: every permit at that address (at most 20 keys). | |
| statuses | No | Status: in_review (applied or approved, not issued yet), active (issued, under way, or on hold), final (completed or closed), inactive (ended without a final: expired, withdrawn, denied, void, or stopped), no_construction (a record with no construction work). | |
| unitsMax | No | Units maximum. | |
| unitsMin | No | Units minimum (homes or apartments on the permit). | |
| valueMax | No | Job value maximum in dollars. | |
| valueMin | No | Job value minimum in dollars, as stated on the permit. "Over $50k" → 50000. | |
| dateField | No | Which date the window applies to: applied, issued, or activity (latest activity, the default). | |
| dateRange | No | Date window. Defaults to 12m. "all" removes the window. | |
| permitIds | No | Permit ids already in hand, at most 10,000. | |
| workTypes | No | Work type keys: new_home, multifamily, adu, manufactured, new_commercial, new_other, addition, interior_remodel, kitchen_bath, tenant_improvement, accessory, structural_repair, repair, hvac, electrical, solar_battery, generator, plumbing, water_heater, gas, fire_protection, telecom, roofing, windows_doors, siding, pool, fence, signage, demolition, grading, utilities, driveway_sidewalk, septic_well, planning, unspecified. A work type is what the job is: roofing = a re-roof or roof repair job. For every job that includes a trade (a new home includes roofing), use trades. | |
| alertScope | No | With alertId: not_dismissed (the default), pending, saved (kept), dismissed, or all. | |
| contractor | No | A contractor's full name, e.g. "Acme Roofing". Case, punctuation, and endings such as LLC, Inc., Corp., Co., and Ltd. are ignored, so "acme roofing" also finds "Acme Roofing, LLC". Every other word counts, so part of a name ("Acme") matches nothing. When unsure of the name, call search_permit_contractors (q with the name words) and pass its contractorKeys. | |
| detailOnly | No | Only permits whose full detail page was read. | |
| maxCredits | No | Optional ceiling on credits this call may spend (API Only and the trial). The API refuses rather than exceed it. | |
| valueBands | No | Value bands: u10k (under $10k), 10k, 50k, 250k, 1m (and up). | |
| workGroups | No | Work type groups: new (new homes and buildings), remodel, systems, exterior, site, planning, unspecified. | |
| assetClasses | No | Building type class (3rd level), e.g. Single-Family Home. | |
| deliveryMode | No | "new" leaves out permits already delivered to this account. Default "all". | |
| permitNumber | No | An exact permit number, e.g. "BLD-2025-01234". Searches every date unless you send a date filter. | |
| hasAnyContact | No | Only permits with any phone or email, private individuals included. | |
| hasContractor | No | Only permits that name a contractor. | |
| propertyTypes | No | Building type, the same labels as planned projects (get_project_types): Residential, Commercial, … | |
| contractorKeys | No | Exact contractor keys from search_permit_contractors (at most 50). Every permit by those contractors. | |
| hasInspections | No | Only permits with at least one inspection that has a result (passed, failed, or completed). | |
| includeRecords | No | Also return non-job records (paperwork on an existing building). Default false. | |
| propertySubtypes | No | More-specific building type (2nd level). | |
| constructionTypes | No | Construction type: new_building, addition, renovation, site_work, infrastructure, demolition_only, none, not_stated. | |
| hasCompanyContact | No | Only permits with a company phone or email printed on them. |