Documentation menu
Schema catalog
The 317 component schemas the API publishes, each with the shape it resolves to.
Operations name these in their request and response blocks. This is the flat list, for when you have a name and want to know what it is. The full definition, including every property, is at /docs/openapi.json.
A few names appear twice with a module prefix, such as envelope__Page and paging__Page. That is the generator keeping two same-named models apart, and the operation that returns one says which.
All schemas
Abandonment
objectAddress
objectAddressComponent
objectAdoption
objectWhich model code edition applies here, adopted at which level, effective when.
Agency
objectAn office.
AgencyRef
objectAggregate
objectMeasurements across an assemblage, derived, with every input named.
Alert
objectAlertBody
objectAlertPatch
objectAnswerReceipt
objectEverything needed to reproduce an answer: inputs, resolved dates, every version consulted.
AsOf
objectWhich law, and which state of our knowledge, this answer describes.
Assessment
objectOne assessment year: what the assessor valued, and what is taxable.
AssessorZoning
objectThe zoning label on the assessor's record. Evidence, never a rule.
Assignment
objectGeometry to district: one row per intersecting district, with the share. Split zoning is normal.
Assumption
objectAuthoredNote
objectAuthority
objectWhich government's rule governs this subject here, on this date, and why.
BBox
objectBand
objectBatch
objectBatchAnswer
objectBatchItem
objectBatchLocation
objectBatchOverride
objectYour correction to one match. Appends a row; never edits the original.
Body
objectA thing that votes.
BodyRef
objectA thing that votes.
Body_token_oauth_token_post
objectBoundary
objectBreakdown
objectCandidate
objectOne possible reading of an ambiguous location. Pass its token back.
Case
objectAn application, from filing to decision.
ChangeEvent
objectOne change, cited on both sides. Events are never rewritten; a restatement is a new seq.
ChangeSide
objectChangeSubject
objectChannel
objectCheckout
objectCheckoutRequest
objectCitation
objectThe passage itself: quoted, located, hashed, dated, and how we got the document.
CitationRef
objectThe inline minimum a fact carries. The full record is one call away at GET /citation/{id}.
Clarification
objectClarificationAnswer
objectClock
objectCode
objectA compiled code: zoning, subdivision and the other regulatory codes, or an adopted model code.
CodeAmendment
objectA local change to an adopted model code.
Collection_Case_
objectCollection_ChangeEvent_
objectCollection_Code_
objectCollection_District_
objectCollection_Document_
objectCollection_Jurisdiction_
objectCollection_MapVersion_
objectCollection_Meeting_
objectCollection_Metric_
objectCollection_Moratorium_
objectCollection_Ordinance_
objectCollection_Parcel_
objectCollection_Permit_
objectCollection_Plan_
objectCollection_Process_
objectCollection_Property_
objectCollection_Region_
objectCollection_RegionalPermission_
objectCollection_Transaction_
objectCollection_Version_
objectCompiledThrough
objectComposition
objectHow a base district and its overlays resolve to one binding answer, and what was displaced.
CompositionCell
objectCompositionRow
objectCondition
objectA condition attached to an approval, as a row. How 'approvals always require Y' becomes queryable.
Confidence
objectNever published without a rubric.
ConformanceAnswer
objectLegal, legally nonconforming, illegal, or indeterminate, and exactly why.
ConformanceRequest
objectConformanceSubject
objectConformsTo
objectConsentRequest
objectWhat the console posts back once a person has approved.
ConsultedVersion
objectContainment
objectThe governments above and below this one, as dated relationships.
Context
objectContextLayer
objectFlood zone, wetland, service area, utility territory, incentive district: one shape for all five.
Contributing
objectControl
objectA standard applied to a use in a district: dimensional, intensity, parking, operational, narrative.
ControlEnvelope
objectBest and worst case across the conditions. Derived, never quoted.
ControlLimit
objectOne of several simultaneous caps: '35 ft and 2.5 stories, whichever is less'.
ControlSegment
objectCorrection
objectA dispute keyed to the passage. Accepted, it becomes a change_event, never a silent edit.
CorrectionRequest
objectCorroboration
objectCost
objectWhat this call spent. BILLING.md, "What a credit buys".
CoverageAnswer
objectCoverageBlock
objectCoverageLayer
objectCoverageRow
objectCreateKeyRequest
objectCreditView
objectCrosswalk
objectCurrentUse
objectDatasetRow
objectDecision
objectDefinition
objectWhat a term means in this town's code, quoted.
Delivery
objectDeliveryTest
objectDesignation
objectOne future land use category a plan defines. A designation is not a permission.
District
objectA zoning district, base or overlay. Controls and permissions come with include=.
Document
objectWhat we retrieved or authored, and from where.
Entitlements
objectWhat this organization may do, and what it has left.
ErrorBody
objectErrorResponse
objectWhat a refusal looks like on the wire.
ErrorWrapper
objectEvaluation
objectOne control applied to one input.
Exemption
objectExtension
objectExtract
objectExtractFile
objectExtractRequest
objectFacet
objectFeature
objectFeatureCollection
objectFee
objectFieldFill
objectHow full one field is, and what mix of statuses fills it, before you filter on it.
Finding
objectFips
objectCensus identity, decomposed, so a caller never parses a string.
FutureLandUse
objectThe plan's designation here. Stated not to be a permission, because it is not one.
Geometry
objectRFC 7946 geometry, lon,lat. Only with field=geometry.
HTTPValidationError
objectHealth
objectWhether the pieces behind the service are up.
Hearing
objectHearingRef
objectHorizon
objectHtmlPassage
objectInquiry
objectInquiryEvent
objectInquiryLocator
objectInquiryRequest
objectInstallment
objectInterruption
objectInterval
objectA resolved time interval. to is absent for an instant.
Invitation
objectInvitationRequest
objectIssuer
objectJurisdiction
objectA general-purpose local government.
JurisdictionRef
objectEnough to name a government and fetch it.
Key
objectLanding
objectLedgerEntry
objectLegalText
objectLink
objectListing_Alert_
objectListing_Delivery_
objectListing_Extract_
objectListing_InquiryEvent_
objectListing_Inquiry_
objectListing_VocabularySummary_
objectListing_Webhook_
objectLoan
objectWhat a recorded mortgage states. Never a balance, payoff or payment history.
LocalTerm
objectMapFeature
objectMapRef
objectMapVersion
objectOne map layer, as adopted. Its dates are its own, separate from the code's.
Margin
objectMe
objectThe signed-in person, as the console needs them for the consent screen.
Measured
objectA number about the land, with where it came from. A cited rule against an anonymous number is half an answer.
MediaTimecode
objectMeeting
objectA scheduled meeting of a body, and its packet.
MembershipRequest
objectAccepting an invitation: the token proves the address, so pick a password.
Meta
objectMetric
objectA statistic, which means it carries its n and its denominator.
MetricCoverage
objectMetricScope
objectMilestone
objectMintedKey
objectModelCode
objectMoney
objectInteger minor units, so a cent is never a float.
Moratorium
objectA pause on a class of development: what, where, until when.
Nonconformity
objectSomething already here that the current rules would not allow, and whether it may stay.
Notice
objectNot an error. Clients threshold on these differently.
ObservedClock
objectDerived from case milestones, with its sample size. Never presented as the rule.
OgcCollection
objectOgcCollections
objectOpposition
objectOne recorded expression of objection or support. Units differ and are never summed.
Ordinance
objectAn adopted or proposed legal instrument, including the ones passed since the code was compiled.
Organization
objectOne organization a person belongs to.
OverlayConsulted
objectOverride
objectOwner
objectOwnership
objectWho the public record says owns the property, over an interval.
Packet
objectParcel
objectA parcel from county records. Geometry is a set of shapes, because one parcel can be many.
ParsedAddress
objectPasswordResetRequest
objectPasswordUpdate
objectPdfPassage
objectPending
objectAdopted, and not yet in force at the requested as_of.
Permission
objectWhether a use is allowed in a district, and on what terms, over time.
PermissionCondition
objectPermissionSegment
objectPermissionVerdict
objectPermit
objectAn issued permit, with the zoning in force when it was issued and the zoning now.
PlaceAnswer
objectWhat is at a location, and whose rules reach it. No rule is asserted here.
PlatRef
objectPlatform
objectPlss
objectPublic Land Survey identity. Not unique: an aliquot can hold many parcels.
Precision
objectWhat the coordinate actually is. Decides which grains we will answer at.
PrecisionFloor
objectPrivateRestriction
objectA recorded restriction that binds the land whatever the zoning says. Never public law.
Process
objectOne kind of application or permit, with everything it takes.
Property
objectThe public-record profile of a property, with its record layers on request.
Proposal
objectWhat you intend to build, in feet and square feet. Anything you omit is not evaluated.
Proposed
objectProvenance
objectHow we obtained a document. Always embedded, never its own endpoint.
PublicNotice
objectA published notice, which appears before a hearing or adoption.
Purpose
objectRatio
object'One stall per 200 sqft of gross floor area': per_value 200, per_unit sqft, per_basis gross_floor_area.
RebuildRight
objectMay this be rebuilt after a casualty. A quoted sentence of the ordinance, with its own citation.
Recorded
objectRecording
objectWhere an instrument sits in the recorder's books.
Region
objectRegionBody
objectRegionCoverage
objectRegionMember
objectRegionPatch
objectRegionalPermission
objectA permission row found by a question that spans jurisdictions.
RegisterClientRequest
objectRFC 7591 Dynamic Client Registration. Deprecated by MCP; kept as fallback.
Relationship
objectRequestEcho
objectRequired
objectRequirement
objectResolution
objectHow the location in the request became a place. Ambiguity is returned, never guessed.
RetryPolicy
objectReview
objectReviewClock
objectReviewStep
objectRollup
objectCoverage counted by governments and by people, because either alone flatters.
RuleAnswer
objectEvery rule at a location on a date. Zeroes are typed in layer[], never omitted.
RuleBatchAnswer
objectRuleBatchItem
objectRuleBatchRequest
objectSearchCorpus
objectSearchScope
objectExactly what was searched.
Section
objectA structural unit of a code. Its citation is ready to quote.
SectionOutline
objectSectionRef
objectStructured section reference, with the jurisdiction's own rendering in label.
SectionSearch
objectSection search carries its denominator: exactly which text was searched.
Service
objectWho answered.
Session
objectA signed-in person, and the token that says so.
Setback
objectSignInRequest
objectSignUpRequest
objectSingle_Alert_
objectSingle_AnswerReceipt_
objectSingle_Case_
objectSingle_ChangeEvent_
objectSingle_Citation_
objectSingle_Code_
objectSingle_Correction_
objectSingle_Delivery_
objectSingle_District_
objectSingle_Document_
objectSingle_Extract_
objectSingle_Inquiry_
objectSingle_Meeting_
objectSingle_Moratorium_
objectSingle_Ordinance_
objectSingle_Parcel_
objectSingle_Permit_
objectSingle_Process_
objectSingle_Property_
objectSingle_Region_
objectSingle_Section_
objectSingle_Transaction_
objectSingle_Version_
objectSingle_Vocabulary_
objectSingle_Webhook_
objectSource
objectSpecialDistrict
objectHistoric, airport, floodplain and similar districts, each with its own authority.
StaffReport
objectStaffStatement
objectStatutoryClock
objectStructure
objectA building or improvement, from assessor building cards, footprints and permits.
Subscription
objectWhat this organization is on, and what it has.
Suggestion
objectA typeahead result that is a ready-to-send query, not a label.
SuggestionAnswer
objectSupersessionRisk
objectTableCell
objectTally
objectTax
objectOne tax bill.
Threshold
objectWhat triggers a permit: 'over 200 square feet'.
TileJSON
objectTileJSON 3.0, plus what is in view and what is not.
TopUpRequest
objectTransaction
objectA recorded instrument that transfers or encumbers an interest.
UsageSummary
objectEverything the usage screen draws, in one call.
UseRef
objectA normalized land use, with the town's own term for it where one exists.
ValidationError
objectValued
objectA money value that may be undisclosed.
VerificationRequest
objectVersion
objectA retained snapshot. Re-extraction with a better engine is a new version; old citations still resolve.
Violation
objectA recorded code enforcement instrument against the property.
Vocabulary
objectVocabularyEntry
objectVocabularySummary
objectVote
objectWebhook
objectWebhookBody
objectWebhookPatch
objectZoningAt
objectThe district in force at a record's own date. Derived, never quoted.
billing__Plan
objectcorpus__Plan
objectparcel__ParcelKey
objectpractice__Party
objectusage__Point
objectOne day.
envelope__Page
objectenvelope__ParcelKey
objectenvelope__Party
objectA name on a public record, shown only as the source shows it.
envelope__Point
objectenvelope__Total
objectpaging__Page
objectWhere this page sits in the result set.
paging__Total
objectHow many rows matched, and whether that number is exact.