Sync new or changed records
get_projects_syncProjects that are new to this account or changed since the last delivery. limit is required. The cursor from the previous page continues the walk; omitting it starts a full walk, last-updated ascending. sort, order, and offset are not accepted. Unchanged owned records do not add a charge. Each new or changed record counts toward 100,000 export records a month on County, State, and National plans. An unchanged record already delivered does not. Find Contact Info does not use credits on this call. On API Only and the trial, costs 1 credit per new or changed record. get_credit_balance returns the remaining balance. Walks private leads by default. leadTypes (for example ["private","public"]) widens it, and changing that value starts a new walk.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"limit": "<limit>"
},
"name": "get_projects_sync"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Same as the Boardwalk map search box. Project name, developer, or words from the filing — e.g. "Ivory apartments Salt Lake". Combine with Region, Type, Acres, and Date Range. | |
| ids | No | Alias of projectIds. | |
| bbox | No | Bounding box as {north,south,east,west} or west,south,east,north. | |
| city | No | Alias of cities. | |
| sort | No | meetingDate, dateAdded, lastUpdated, dataRichness, totalUnitCount, acreage — or product aliases meeting_date_newest, created_at_newest, units_highest, acres_highest. "Recently added" is dateAdded (newest first by default). Do not send suggested (map-only). | |
| type | No | Alias of propertyTypes. | |
| limit | Yes | Required. Number of records to return, 1-25. Each new or changed record counts toward 100,000 export records a month. An unchanged record already delivered does not. | |
| order | No | ||
| state | No | Alias of states. | |
| bounds | No | Alias of bbox. | |
| circle | No | Radius search {lat, lng, radiusMeters}. radiusMeters is 100–500000 (meters, not miles). | |
| cities | No | Region: city ids or names. Narrows states the same way counties do. | |
| cityId | No | ||
| county | No | Alias of counties. | |
| cursor | No | Opaque cursor from the previous sync page. Omit to start a full walk. | |
| dateTo | No | ||
| inSfha | No | Alias of inFemaFloodZone. | |
| offset | No | ||
| search | No | Alias of q. | |
| states | No | Region: state ids, names, or abbreviations. Resolve names via list_locations if unsure. | |
| status | No | Entitlement status, whoever gave it. Tokens from get_reference facet=statuses. To ask who gave it as well, use entitlementStatus. | |
| cityIds | No | ||
| include | No | Pass "contacts" with projectIds to read stored contacts after enrichment. get_projects uses cachedOnly=true; it never starts a live lookup. Use create_enrichment to find new contact info. | |
| polygon | No | GeoJSON ring [[lng,lat],…]. | |
| stateId | No | ||
| subtype | No | Alias of propertySubtypes. | |
| counties | No | Region: county ids or names. When using names, send states separately (e.g. states:["UT"], counties:["Davis"]). Do not put "County, ST" in one value. Ambiguous names are refused even on a single-state plan. Naming a county or city narrows the search to it: states sent with it are not searched in full, and the response warns geography_narrowed_to_smallest_scope. | |
| countyId | No | ||
| dateFrom | No | Date Range lower bound, YYYY-MM or YYYY-MM-DD | |
| stateIds | No | Alias of states. | |
| countyIds | No | ||
| dateRange | No | Date Range chip. Defaults to last_1_year. Pass "all" for the whole corpus. | |
| leadTypes | No | Lead types to include. Default ["private"] — private development only, same as the map. Widen it when they ask: ["private","public"] adds public-sector projects (schools, roads, utilities, civic facilities); ["private","private_minor"] adds small private jobs (single lots, tenant improvements, small additions); "public_minor" adds small public jobs. Infrastructure and Institutional/Public projects are mostly government-owned, so add "public" whenever you filter for them (propertyTypes Infrastructure or Institutional/Public, or constructionTypes infrastructure). Always keep "private" in the list — the API adds it back if you drop it. Standard and full records carry leadType and stage; compact omits them. | |
| acreageMax | No | Acres maximum. | |
| acreageMin | No | Acres minimum. “Projects over 2 acres” → acreageMin=2. | |
| assetClass | No | Alias of assetClasses. | |
| lotSizeMax | No | Alias — prefer acreageMax when they said acres. | |
| lotSizeMin | No | Alias — prefer acreageMin when they said acres. | |
| projectIds | No | Exact record ids to re-read, at most 100. Owned unchanged records are free. On count_projects this must be the only filter. | |
| projectName | No | ||
| assetClasses | No | Building type class (3rd level: Gas Stations, Apartment Building, …). | |
| deliveryMode | No | Sync returns all matching records and their delivery state. For never-delivered records only, use get_projects with deliveryMode=new. | |
| excludeSaved | No | When true, hide projects already on a saved list this account can see. | |
| projectSizes | No | Project Size: large, medium, or small. “Large projects” → large. | |
| requestTypes | No | Application type, what they asked for. Early: annexation, general_plan_amendment, rezone, planned_unit_development, concept_plan, project_plan. Middle: conditional_use_permit, special_use_permit, variance, development_agreement, preliminary_plat, subdivision_plat. Late: site_plan_approval, design_review, final_plat. Early types are the first sign of a project; late ones mean it is close to building. | |
| unitCountMax | No | Alias of totalUnitCountMax. | |
| unitCountMin | No | Alias of totalUnitCountMin. | |
| civicSubtypes | No | Alias of governmentDecisionSubtypes. | |
| decisionTypes | No | ||
| developerName | No | ||
| lastUpdatedTo | No | ||
| meetingDateTo | No | ||
| propertyTypes | No | Building type from get_project_types (Commercial, Residential, …). Alias: type. | |
| excludeAlertId | No | Subtract every project any delivery of this alert (alr_…) has ever materialised. | |
| excludeSubtype | No | Alias of excludePropertySubtypes. | |
| lotSizeSqftMax | No | Alias of lotSizeMax. | |
| lotSizeSqftMin | No | Alias of lotSizeMin. | |
| showAllRecords | No | Alias of includeGovernmentDecisions. | |
| inFemaFloodZone | No | FEMA flood zone overlay. | |
| lastUpdatedFrom | No | ||
| meetingDateFrom | No | ||
| applicationTypes | No | Alias of requestTypes. | |
| parkingSpacesMax | No | ||
| parkingSpacesMin | No | ||
| propertySubtypes | No | More-specific building type (2nd level). | |
| squareFootageMax | No | Building square footage maximum. | |
| squareFootageMin | No | Building square footage minimum. | |
| civicAssetClasses | No | Alias of governmentDecisionAssetClasses. | |
| constructionTypes | No | Construction type: new_building, renovation, addition, infrastructure. "Renovation or addition" is renovation plus addition, so send both. | |
| entitlementStatus | No | Entitlement status by who gave it, as "<bodyGroup>:<status>" pairs, e.g. ["council:approved","planning:recommended_for_approval"]. A pair matches the project's newest decision. Body groups: council (city council or county board), planning (planning commission), boards (appeals and review boards), staff (planning staff), other (another body). Statuses: approved, denied, recommended_for_approval, recommended_for_denial, continued, pending, withdrawn. "Approved by the planning commission" → ["planning:approved"]. get_reference facet=entitlementStatus lists both halves. | |
| excludeAssetClass | No | Alias of excludeAssetClasses. | |
| excludeProjectIds | No | Subtract these ids from search/count (at most 100). | |
| inOpportunityZone | No | 2027 Opportunity Zone overlay (effective January 1, 2027). | |
| taxonomyMatchMode | No | How a Building type filter matches. Default primary_or_secondary. Rarely needed. | |
| totalUnitCountMax | No | Residential Units maximum. | |
| totalUnitCountMin | No | Residential Units minimum. | |
| buildingStoriesMax | No | ||
| buildingStoriesMin | No | ||
| excludeAssetClasses | No | Building type classes to leave out. | |
| constructionLeadOnly | No | Alias of constructionLeadsOnly. | |
| constructionLeadsOnly | No | ||
| constructionMagnitudes | No | Alias of projectSizes. | |
| hasConstructionDetails | No | ||
| excludePropertySubtypes | No | Building types to leave out (2nd level). | |
| governmentDecisionSubtypes | No | Government decision types. Requires includeGovernmentDecisions=true. | |
| includeGovernmentDecisions | No | Include non-real-estate government decisions (ordinances, budgets). Default false. Pass true only when they ask for them. Deprecated: still accepted, but leadTypes is how the served set is widened now — prefer leadTypes: ["private","public"] for public-sector work. | |
| governmentDecisionAssetClasses | No | Government decision classes. Requires includeGovernmentDecisions=true. |