Properties
| Name | Type | Description |
|---|---|---|
| requestId | integer | |
| status | string | |
| creditsReserved | integer | |
| creditsCharged | integernull | |
| data | arraynull | Project results when completed or partial; null while queued/running. |
| meta | objectnull | Same shape as sync AI search meta when completed, plus matchesByProjectId. |
| error | stringnull | |
| progress | objectnull | Live screening progress while queued or running. |
| stopReason | stringnull | |
| partialReason | stringnull | |
| createdAt | string | |
| startedAt | stringnull | |
| completedAt | stringnull | |
| expiresAt | stringnull |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/boardwalkai-com/json-schema/boardwalkai-com-ai-search-job-status-schema.json",
"title": "AiSearchJobStatus",
"x-generated": "2026-11-02",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/boardwalkai-com-openapi.yml#/components/schemas/AiSearchJobStatus",
"type": "object",
"properties": {
"requestId": {
"type": "integer"
},
"status": {
"type": "string",
"enum": [
"queued",
"running",
"completed",
"partial",
"failed",
"cancelled",
"expired"
]
},
"creditsReserved": {
"type": "integer"
},
"creditsCharged": {
"type": [
"integer",
"null"
]
},
"data": {
"description": "Project results when completed or partial; null while queued/running.",
"type": [
"array",
"null"
],
"items": {
"oneOf": [
{
"$ref": "#/$defs/ProjectRecordCompact"
},
{
"$ref": "#/$defs/ProjectRecord"
},
{
"$ref": "#/$defs/ProjectRecordFull"
}
]
}
},
"meta": {
"type": [
"object",
"null"
],
"description": "Same shape as sync AI search meta when completed, plus matchesByProjectId.",
"allOf": [
{
"$ref": "#/$defs/AiSearchJobMeta"
}
]
},
"error": {
"type": [
"string",
"null"
]
},
"progress": {
"type": [
"object",
"null"
],
"description": "Live screening progress while queued or running.",
"properties": {
"stage": {
"type": "string",
"enum": [
"queued",
"screening"
]
},
"candidatesRetrieved": {
"type": [
"integer",
"null"
]
},
"candidatesScreened": {
"type": "integer",
"minimum": 0
},
"batchesRun": {
"type": "integer",
"minimum": 0
},
"screeningCeiling": {
"type": [
"integer",
"null"
]
},
"confirmedSoFar": {
"type": "integer",
"minimum": 0
},
"cancelRequested": {
"type": "boolean"
}
}
},
"stopReason": {
"type": [
"string",
"null"
]
},
"partialReason": {
"type": [
"string",
"null"
]
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"startedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"completedAt": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"expiresAt": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"$defs": {
"AiMatch": {
"type": "object",
"title": "AI Match",
"required": [
"score",
"summary",
"channels"
],
"additionalProperties": false,
"properties": {
"score": {
"type": [
"number",
"null"
]
},
"summary": {
"type": [
"string",
"null"
]
},
"channels": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
}
}
},
"AiPaginationMeta": {
"type": "object",
"properties": {
"schemaVersion": {
"type": "string",
"description": "The response-contract version. Also sent as the X-Boardwalk-Schema-Version header."
},
"representation": {
"type": "string",
"enum": [
"compact",
"standard",
"full"
]
},
"total": {
"type": "integer",
"description": "The AI search engine's reported result-set total before page delivery."
},
"limit": {
"type": "integer"
},
"offset": {
"type": "integer"
},
"pageCount": {
"type": "integer",
"description": "Records returned on this page after collapse and the serving gate."
},
"hasMore": {
"type": "boolean",
"description": "Whether the retrieved eligible candidate pool contains another page."
},
"filteredAfterSearch": {
"type": "object",
"additionalProperties": {
"type": "integer"
},
"description": "Candidates removed after ranking; `servingGate`, `hardConstraints`, and `mergeCollapse` candidates never fill a paid page slot."
},
"creditsUsed": {
"type": "integer"
},
"creditsRemaining": {
"type": "integer"
},
"trialTruncation": {
"$ref": "#/$defs/TrialTruncation"
},
"searchMethod": {
"type": "string"
},
"duplicatesCollapsed": {
"type": "integer",
"description": "Duplicate ids folded together in the bounded ranked candidate pool before paging."
},
"collapseApplied": {
"type": "boolean"
},
"delivery": {
"$ref": "#/$defs/DeliveryMeta"
},
"requestId": {
"type": "string"
}
}
},
"AiSearchJobMeta": {
"description": "Completed AI-search job metadata, including evidence and screening state.",
"allOf": [
{
"$ref": "#/$defs/AiPaginationMeta"
},
{
"type": "object",
"properties": {
"creditsReserved": {
"type": "integer"
},
"parsedQuery": {
"type": "object",
"additionalProperties": true
},
"matchesByProjectId": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": true
}
},
"lowConfidence": {
"type": "boolean"
},
"stopReason": {
"type": "string"
},
"candidatesRetrieved": {
"type": "integer"
},
"candidatesScreened": {
"type": "integer"
},
"batchesRun": {
"type": "integer"
},
"screeningCeiling": {
"type": "integer"
},
"screeningCeilingSource": {
"type": "string"
},
"batchSizeYields": {
"type": "array",
"items": {
"type": "integer"
}
},
"partialReason": {
"type": [
"string",
"null"
]
},
"matchCount": {
"type": "integer",
"description": "Verified matches that survived final delivery eligibility and hard-constraint revalidation, before offset."
},
"matchCountIsExact": {
"type": "boolean"
},
"reusedVerdictCount": {
"type": "integer"
},
"verifierErrorCount": {
"type": "integer"
},
"enrichment": {
"type": "object",
"additionalProperties": true
}
}
}
]
},
"AlertMatch": {
"type": "object",
"title": "Alert Match",
"required": [
"alertName",
"why",
"quotes"
],
"additionalProperties": false,
"properties": {
"alertName": {
"type": [
"string",
"null"
]
},
"why": {
"type": [
"string",
"null"
]
},
"quotes": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
}
}
},
"Contact": {
"type": "object",
"title": "Contacts",
"required": [
"name",
"title",
"role",
"roleLabel",
"partyClass",
"partyClassLabel",
"entityType",
"company",
"email",
"emailSource",
"phone",
"phoneSource",
"linkedinUrl",
"linkedinSource",
"contactProvenance",
"enrichmentSource",
"enrichedAt",
"enrichmentStatus",
"contactsWithheldReason"
],
"additionalProperties": false,
"properties": {
"name": {
"type": [
"string",
"null"
]
},
"title": {
"type": [
"string",
"null"
]
},
"role": {
"type": [
"string",
"null"
]
},
"roleLabel": {
"type": [
"string",
"null"
]
},
"partyClass": {
"type": [
"string",
"null"
]
},
"partyClassLabel": {
"type": [
"string",
"null"
]
},
"entityType": {
"type": [
"string",
"null"
]
},
"company": {
"type": [
"string",
"null"
]
},
"email": {
"type": [
"string",
"null"
]
},
"emailSource": {
"type": [
"string",
"null"
]
},
"phone": {
"type": [
"string",
"null"
]
},
"phoneSource": {
"type": [
"string",
"null"
]
},
"linkedinUrl": {
"type": [
"string",
"null"
]
},
"linkedinSource": {
"type": [
"string",
"null"
]
},
"contactProvenance": {
"type": [
"string",
"null"
]
},
"enrichmentSource": {
"type": [
"string",
"null"
]
},
"enrichedAt": {
"type": [
"string",
"null"
]
},
"enrichmentStatus": {
"type": [
"string",
"null"
]
},
"contactsWithheldReason": {
"type": [
"string",
"null"
]
}
}
},
"ContactSummary": {
"type": "object",
"title": "Contact Summary",
"required": [
"externalCount",
"governmentCount",
"unclassifiedCount",
"withEmail",
"withPhone",
"withLinkedin",
"enrichedCount",
"lowConfidenceWithheld",
"withheldCount",
"withheldReason"
],
"additionalProperties": false,
"properties": {
"externalCount": {
"type": [
"integer",
"null"
]
},
"governmentCount": {
"type": [
"integer",
"null"
]
},
"unclassifiedCount": {
"type": [
"integer",
"null"
]
},
"withEmail": {
"type": [
"integer",
"null"
]
},
"withPhone": {
"type": [
"integer",
"null"
]
},
"withLinkedin": {
"type": [
"integer",
"null"
]
},
"enrichedCount": {
"type": [
"integer",
"null"
]
},
"lowConfidenceWithheld": {
"type": [
"integer",
"null"
]
},
"withheldCount": {
"type": [
"integer",
"null"
]
},
"withheldReason": {
"type": [
"string",
"null"
]
}
}
},
"DeliveryMeta": {
"type": "object",
"description": "What this page cost you, split by delivery history. A record you have already been delivered and that has not changed is returned again without being charged again.",
"properties": {
"mode": {
"type": "string"
},
"notPreviouslyExported": {
"type": "integer"
},
"previouslyExported": {
"type": "integer"
},
"updatedSinceExport": {
"type": "integer"
},
"billed": {
"type": "integer",
"description": "Records charged for on this response."
},
"notRebilled": {
"type": "integer",
"description": "Records returned free because you already had them."
},
"ledgerApplied": {
"type": "boolean"
}
}
},
"DeliveryState": {
"type": "object",
"title": "Delivery State",
"required": [
"alreadyExported",
"updatedSinceExport",
"lastExportedAt",
"billed"
],
"additionalProperties": false,
"properties": {
"alreadyExported": {
"type": [
"boolean",
"null"
]
},
"updatedSinceExport": {
"type": [
"boolean",
"null"
]
},
"lastExportedAt": {
"type": [
"string",
"null"
]
},
"billed": {
"type": [
"boolean",
"null"
]
}
}
},
"EnrichedCompany": {
"type": "object",
"title": "Company Enrichment",
"required": [
"name",
"website",
"linkedinUrl",
"archetype",
"phone"
],
"additionalProperties": false,
"properties": {
"name": {
"type": [
"string",
"null"
]
},
"website": {
"type": [
"string",
"null"
]
},
"linkedinUrl": {
"type": [
"string",
"null"
]
},
"archetype": {
"type": [
"string",
"null"
]
},
"phone": {
"type": [
"string",
"null"
]
}
}
},
"KeyFact": {
"type": "object",
"title": "Key Facts",
"required": [
"fact",
"category",
"categoryLabel"
],
"additionalProperties": false,
"properties": {
"fact": {
"type": [
"string",
"null"
]
},
"category": {
"type": [
"string",
"null"
]
},
"categoryLabel": {
"type": [
"string",
"null"
]
}
}
},
"LikelyTrade": {
"type": "object",
"title": "Likely Trades",
"required": [
"trade",
"tradeLabel",
"basis"
],
"additionalProperties": false,
"properties": {
"trade": {
"type": [
"string",
"null"
]
},
"tradeLabel": {
"type": [
"string",
"null"
]
},
"basis": {
"type": [
"string",
"null"
]
}
}
},
"ProjectAddress": {
"type": "object",
"title": "Additional Addresses",
"required": [
"address",
"city",
"state",
"postalCode",
"latitude",
"longitude"
],
"additionalProperties": false,
"properties": {
"address": {
"type": [
"string",
"null"
]
},
"city": {
"type": [
"string",
"null"
]
},
"state": {
"type": [
"string",
"null"
]
},
"postalCode": {
"type": [
"string",
"null"
]
},
"latitude": {
"type": [
"number",
"null"
]
},
"longitude": {
"type": [
"number",
"null"
]
}
}
},
"ProjectClassification": {
"type": "object",
"title": "All Classifications",
"required": [
"role",
"type",
"typeLabel",
"subtype",
"subtypeLabel",
"assetClass",
"assetClassLabel"
],
"additionalProperties": false,
"properties": {
"role": {
"type": [
"string",
"null"
]
},
"type": {
"type": [
"string",
"null"
]
},
"typeLabel": {
"type": [
"string",
"null"
]
},
"subtype": {
"type": [
"string",
"null"
]
},
"subtypeLabel": {
"type": [
"string",
"null"
]
},
"assetClass": {
"type": [
"string",
"null"
]
},
"assetClassLabel": {
"type": [
"string",
"null"
]
}
}
},
"ProjectDecision": {
"type": "object",
"title": "Decisions",
"required": [
"meetingDate",
"decisionBody",
"actionType",
"actionTypeLabel",
"requestType",
"requestTypeLabel",
"outcome",
"outcomeLabel",
"motionType",
"motionOutcome",
"evidenceBasis",
"evidenceBasisLabel",
"isConsentAgenda",
"caseNumber",
"evidence",
"conditions",
"voteTally",
"votes"
],
"additionalProperties": false,
"properties": {
"meetingDate": {
"type": [
"string",
"null"
]
},
"decisionBody": {
"type": [
"string",
"null"
]
},
"actionType": {
"type": [
"string",
"null"
]
},
"actionTypeLabel": {
"type": [
"string",
"null"
]
},
"requestType": {
"type": [
"string",
"null"
]
},
"requestTypeLabel": {
"type": [
"string",
"null"
]
},
"outcome": {
"type": [
"string",
"null"
]
},
"outcomeLabel": {
"type": [
"string",
"null"
]
},
"motionType": {
"type": [
"string",
"null"
]
},
"motionOutcome": {
"type": [
"string",
"null"
]
},
"evidenceBasis": {
"type": [
"string",
"null"
]
},
"evidenceBasisLabel": {
"type": [
"string",
"null"
]
},
"isConsentAgenda": {
"type": [
"boolean",
"null"
]
},
"caseNumber": {
"type": [
"string",
"null"
]
},
"evidence": {
"type": [
"string",
"null"
]
},
"conditions": {
"type": [
"string",
"null"
]
},
"voteTally": {
"nullable": true,
"allOf": [
{
"$ref": "#/$defs/VoteTally"
}
]
},
"votes": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/Vote"
}
}
}
},
"ProjectLandUse": {
"type": "object",
"title": "Land Uses",
"required": [
"type",
"typeLabel",
"subtype",
"subtypeLabel",
"assetClass",
"assetClassLabel",
"matchedOn"
],
"additionalProperties": false,
"properties": {
"type": {
"type": [
"string",
"null"
]
},
"typeLabel": {
"type": [
"string",
"null"
]
},
"subtype": {
"type": [
"string",
"null"
]
},
"subtypeLabel": {
"type": [
"string",
"null"
]
},
"assetClass": {
"type": [
"string",
"null"
]
},
"assetClassLabel": {
"type": [
"string",
"null"
]
},
"matchedOn": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
}
}
}
},
"ProjectRecord": {
"type": "object",
"description": "A land use project record at the `standard` representation. Every representation costs the same 1 credit per record. Where our current-generation extraction has not covered an attribute, the field is null rather than filled from an older, less accurate source.",
"required": [
"id",
"recordType",
"projectName",
"projectHeadline",
"boardwalkLink",
"mergedFrom",
"lastUpdated",
"meetingDate",
"delivery",
"address",
"city",
"county",
"state",
"postalCode",
"latitude",
"longitude",
"locationPrecision",
"locationPrecisionLabel",
"isApproximate",
"parcelApn",
"inOpportunityZone",
"inFemaFloodZone",
"propertyType",
"propertyTypeLabel",
"propertySubtype",
"propertySubtypeLabel",
"assetClass",
"assetClassLabel",
"leadType",
"leadTypeLabel",
"stage",
"stageLabel",
"landUses",
"status",
"statusLabel",
"statusSummary",
"requestType",
"requestTypeLabel",
"decisionBody",
"caseNumbers",
"acreage",
"squareFootage",
"unitMix",
"totalUnitCount",
"bedroomCount",
"buildingStories",
"floorCount",
"buildingHeightFeet",
"parkingSpaces",
"existingZoning",
"proposedZoning",
"isRezone",
"constructionType",
"constructionTypeLabel",
"projectSize",
"projectSizeLabel",
"developerCompany",
"developerCompanyRole",
"developerCompanyRoleLabel",
"contacts",
"contactEnrichment",
"companyEnrichment",
"publicOfficials",
"contactSummary",
"keyFacts",
"evidence",
"summary",
"voteSummary",
"sourceDocumentUrl"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "integer",
"description": "Boardwalk's stable identifier for this project.",
"x-group": "identity",
"x-csv-field": "project_id"
},
"recordType": {
"type": "string",
"description": "What kind of record this is. Always \"project\" today; reserved for future record types.",
"x-group": "identity"
},
"projectName": {
"type": "string",
"description": "The project's display name.",
"x-group": "identity",
"x-csv-field": "project_name"
},
"projectHeadline": {
"type": [
"string",
"null"
],
"description": "A one-line description of the latest development on this project.",
"x-group": "identity",
"x-csv-field": "project_headline"
},
"boardwalkLink": {
"type": "string",
"format": "uri",
"description": "Deep link to this project in the Boardwalk map.",
"x-group": "identity",
"x-csv-field": "boardwalk_link"
},
"mergedFrom": {
"type": "array",
"description": "The project ids folded into this record as duplicates of the same development, including its own. You are billed once for the record, not once per id.",
"x-group": "identity",
"items": {
"type": "integer"
}
},
"lastUpdated": {
"type": [
"string",
"null"
],
"format": "date-time",
"description": "When this project record last changed, RFC 3339 UTC.",
"x-group": "identity",
"x-csv-field": "last_updated"
},
"meetingDate": {
"type": [
"string",
"null"
],
"format": "date",
"description": "The date of the most recent public meeting this project appeared at. For a merged development this is reconciled across the whole family (the newest hearing of any merged record, never later than today or than your meetingDateTo bound), so it matches the product map and your date filters.",
"x-group": "identity",
"x-csv-field": "meeting_date"
},
"delivery": {
"nullable": true,
"description": "What Boardwalk has already delivered to your credit pool for this record, and whether this delivery was billed. GET /projects/sync returns these same four keys plus a change payload (what moved, and which new filing caused it). See the SyncDeliveryState schema.",
"x-group": "delivery",
"allOf": [
{
"$ref": "#/$defs/DeliveryState"
}
]
},
"address": {
"type": [
"string",
"null"
],
"description": "The project's street address as stated in the public filing.",
"x-group": "location",
"x-csv-field": "address"
},
"city": {
"type": [
"string",
"null"
],
"description": "City the project is in.",
"x-group": "location",
"x-csv-field": "city"
},
"county": {
"type": [
"string",
"null"
],
"description": "County the project is in.",
"x-group": "location",
"x-csv-field": "county"
},
"state": {
"type": [
"string",
"null"
],
"description": "Two-letter state code.",
"x-group": "location",
"x-csv-field": "state"
},
"postalCode": {
"type": [
"string",
"null"
],
"description": "Postal code of the project's primary address.",
"x-group": "location"
},
"latitude": {
"type": [
"number",
"null"
],
"description": "Latitude of the project's mapped location.",
"x-group": "location"
},
"longitude": {
"type": [
"number",
"null"
],
"description": "Longitude of the project's mapped location.",
"x-group": "location"
},
"locationPrecision": {
"type": [
"string",
"null"
],
"description": "How precisely this project is placed: address, parcel, location_description, city or county.",
"x-group": "location"
},
"locationPrecisionLabel": {
"type": [
"string",
"null"
],
"description": "Human-readable form of locationPrecision.",
"x-group": "location"
},
"isApproximate": {
"type": "boolean",
"description": "True when the coordinates are inferred rather than taken from a street address.",
"x-group": "location"
},
"parcelApn": {
"type": "array",
"description": "Assessor parcel numbers named in the filing.",
"x-group": "location",
"x-csv-field": "parcel_apn",
"items": {
"type": "string"
}
},
"inOpportunityZone": {
"type": [
"boolean",
"null"
],
"description": "Whether the site is inside a federal Opportunity Zone (2018 designation). Null means membership has not been computed, never false.",
"x-group": "location"
},
"inFemaFloodZone": {
"type": [
"boolean",
"null"
],
"description": "Whether the site is inside a FEMA Special Flood Hazard Area, the 1%-annual-chance regulatory flood zone. Null means membership has not been computed, never false.",
"x-group": "location"
},
"propertyType": {
"type": [
"string",
"null"
],
"description": "Top-level land-use classification, e.g. residential.",
"x-group": "classification",
"x-csv-field": "property_type"
},
"propertyTypeLabel": {
"type": [
"string",
"null"
],
"description": "Human-readable form of propertyType.",
"x-group": "classification"
},
"propertySubtype": {
"type": [
"string",
"null"
],
"description": "Second-level land-use classification, e.g. multifamily.",
"x-group": "classification",
"x-csv-field": "property_subtype"
},
"propertySubtypeLabel": {
"type": [
"string",
"null"
],
"description": "Human-readable form of propertySubtype.",
"x-group": "classification"
},
"assetClass": {
"type": [
"string",
"null"
],
"description": "Third-level land-use classification for the project's headline use, e.g. apartments: the first one we know where that use stops short of this level. Blank means the project has no asset class recorded at all; see `landUses` for every use it does have. Never a duplicated parent value.",
"x-group": "classification",
"x-csv-field": "asset_class"
},
"assetClassLabel": {
"type": [
"string",
"null"
],
"description": "Human-readable form of assetClass.",
"x-group": "classification"
},
"leadType": {
"type": [
"string",
"null"
],
"description": "Boardwalk's read of the record as a lead: private (private development), public (roads, schools, utilities, public buildings), private_minor (a small private job: a single home, a tenant finish, a lot split) or public_minor. Search returns private by default; widen it with the leadTypes filter. Null while the record is awaiting review.",
"x-group": "classification",
"x-csv-field": "lead_type"
},
"leadTypeLabel": {
"type": [
"string",
"null"
],
"description": "Human-readable form of leadType.",
"x-group": "classification"
},
"stage": {
"type": [
"string",
"null"
],
"description": "Where the project is in its life: concept_or_planning
# --- truncated at 32 KB (88 KB total) ---
# Full source: https://artifacts.apis.io/boardwalkai-com/json-schema/boardwalkai-com-ai-search-job-status-schema.json
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/boardwalkai-com-ai-search-job-status"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.