Documentation menu
API

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

object

Address

object

AddressComponent

object

Adoption

object

Which model code edition applies here, adopted at which level, effective when.

Agency

object

An office.

AgencyRef

object

Aggregate

object

Measurements across an assemblage, derived, with every input named.

Alert

object

AlertBody

object

AlertPatch

object

AnswerReceipt

object

Everything needed to reproduce an answer: inputs, resolved dates, every version consulted.

AsOf

object

Which law, and which state of our knowledge, this answer describes.

Assessment

object

One assessment year: what the assessor valued, and what is taxable.

AssessorZoning

object

The zoning label on the assessor's record. Evidence, never a rule.

Assignment

object

Geometry to district: one row per intersecting district, with the share. Split zoning is normal.

Assumption

object

AuthoredNote

object

Authority

object

Which government's rule governs this subject here, on this date, and why.

BBox

object

Band

object

Batch

object

BatchAnswer

object

BatchItem

object

BatchLocation

object

BatchOverride

object

Your correction to one match. Appends a row; never edits the original.

Body

object

A thing that votes.

BodyRef

object

A thing that votes.

Body_token_oauth_token_post

object

Boundary

object

Breakdown

object

Candidate

object

One possible reading of an ambiguous location. Pass its token back.

Case

object

An application, from filing to decision.

ChangeEvent

object

One change, cited on both sides. Events are never rewritten; a restatement is a new seq.

ChangeSide

object

ChangeSubject

object

Channel

object

Checkout

object

CheckoutRequest

object

Citation

object

The passage itself: quoted, located, hashed, dated, and how we got the document.

CitationRef

object

The inline minimum a fact carries. The full record is one call away at GET /citation/{id}.

Clarification

object

ClarificationAnswer

object

Clock

object

Code

object

A compiled code: zoning, subdivision and the other regulatory codes, or an adopted model code.

CodeAmendment

object

A local change to an adopted model code.

Collection_Case_

object

Collection_ChangeEvent_

object

Collection_Code_

object

Collection_District_

object

Collection_Document_

object

Collection_Jurisdiction_

object

Collection_MapVersion_

object

Collection_Meeting_

object

Collection_Metric_

object

Collection_Moratorium_

object

Collection_Ordinance_

object

Collection_Parcel_

object

Collection_Permit_

object

Collection_Plan_

object

Collection_Process_

object

Collection_Property_

object

Collection_Region_

object

Collection_RegionalPermission_

object

Collection_Transaction_

object

Collection_Version_

object

CompiledThrough

object

Composition

object

How a base district and its overlays resolve to one binding answer, and what was displaced.

CompositionCell

object

CompositionRow

object

Condition

object

A condition attached to an approval, as a row. How 'approvals always require Y' becomes queryable.

Confidence

object

Never published without a rubric.

ConformanceAnswer

object

Legal, legally nonconforming, illegal, or indeterminate, and exactly why.

ConformanceRequest

object

ConformanceSubject

object

ConformsTo

object

ConsentRequest

object

What the console posts back once a person has approved.

ConsultedVersion

object

Containment

object

The governments above and below this one, as dated relationships.

Context

object

ContextLayer

object

Flood zone, wetland, service area, utility territory, incentive district: one shape for all five.

Contributing

object

Control

object

A standard applied to a use in a district: dimensional, intensity, parking, operational, narrative.

ControlEnvelope

object

Best and worst case across the conditions. Derived, never quoted.

ControlLimit

object

One of several simultaneous caps: '35 ft and 2.5 stories, whichever is less'.

ControlSegment

object

Correction

object

A dispute keyed to the passage. Accepted, it becomes a change_event, never a silent edit.

CorrectionRequest

object

Corroboration

object

Cost

object

What this call spent. BILLING.md, "What a credit buys".

CoverageAnswer

object

CoverageBlock

object

CoverageLayer

object

CoverageRow

object

CreateKeyRequest

object

CreditView

object

Crosswalk

object

CurrentUse

object

DatasetRow

object

Decision

object

Definition

object

What a term means in this town's code, quoted.

Delivery

object

DeliveryTest

object

Designation

object

One future land use category a plan defines. A designation is not a permission.

District

object

A zoning district, base or overlay. Controls and permissions come with include=.

Document

object

What we retrieved or authored, and from where.

Entitlements

object

What this organization may do, and what it has left.

ErrorBody

object

ErrorResponse

object

What a refusal looks like on the wire.

ErrorWrapper

object

Evaluation

object

One control applied to one input.

Exemption

object

Extension

object

Extract

object

ExtractFile

object

ExtractRequest

object

Facet

object

Feature

object

FeatureCollection

object

Fee

object

FieldFill

object

How full one field is, and what mix of statuses fills it, before you filter on it.

Finding

object

Fips

object

Census identity, decomposed, so a caller never parses a string.

FutureLandUse

object

The plan's designation here. Stated not to be a permission, because it is not one.

Geometry

object

RFC 7946 geometry, lon,lat. Only with field=geometry.

HTTPValidationError

object

Health

object

Whether the pieces behind the service are up.

Hearing

object

HearingRef

object

Horizon

object

HtmlPassage

object

Inquiry

object

InquiryEvent

object

InquiryLocator

object

InquiryRequest

object

Installment

object

Interruption

object

Interval

object

A resolved time interval. to is absent for an instant.

Invitation

object

InvitationRequest

object

Issuer

object

Jurisdiction

object

A general-purpose local government.

JurisdictionRef

object

Enough to name a government and fetch it.

Key

object

Landing

object

LedgerEntry

object

LegalText

object

Listing_Alert_

object

Listing_Delivery_

object

Listing_Extract_

object

Listing_InquiryEvent_

object

Listing_Inquiry_

object

Listing_VocabularySummary_

object

Listing_Webhook_

object

Loan

object

What a recorded mortgage states. Never a balance, payoff or payment history.

LocalTerm

object

MapFeature

object

MapRef

object

MapVersion

object

One map layer, as adopted. Its dates are its own, separate from the code's.

Margin

object

Me

object

The signed-in person, as the console needs them for the consent screen.

Measured

object

A number about the land, with where it came from. A cited rule against an anonymous number is half an answer.

MediaTimecode

object

Meeting

object

A scheduled meeting of a body, and its packet.

MembershipRequest

object

Accepting an invitation: the token proves the address, so pick a password.

Meta

object

Metric

object

A statistic, which means it carries its n and its denominator.

MetricCoverage

object

MetricScope

object

Milestone

object

MintedKey

object

ModelCode

object

Money

object

Integer minor units, so a cent is never a float.

Moratorium

object

A pause on a class of development: what, where, until when.

Nonconformity

object

Something already here that the current rules would not allow, and whether it may stay.

Notice

object

Not an error. Clients threshold on these differently.

ObservedClock

object

Derived from case milestones, with its sample size. Never presented as the rule.

OgcCollection

object

OgcCollections

object

Opposition

object

One recorded expression of objection or support. Units differ and are never summed.

Ordinance

object

An adopted or proposed legal instrument, including the ones passed since the code was compiled.

Organization

object

One organization a person belongs to.

OverlayConsulted

object

Override

object

Owner

object

Ownership

object

Who the public record says owns the property, over an interval.

Packet

object

Parcel

object

A parcel from county records. Geometry is a set of shapes, because one parcel can be many.

ParsedAddress

object

PasswordResetRequest

object

PasswordUpdate

object

PdfPassage

object

Pending

object

Adopted, and not yet in force at the requested as_of.

Permission

object

Whether a use is allowed in a district, and on what terms, over time.

PermissionCondition

object

PermissionSegment

object

PermissionVerdict

object

Permit

object

An issued permit, with the zoning in force when it was issued and the zoning now.

PlaceAnswer

object

What is at a location, and whose rules reach it. No rule is asserted here.

PlatRef

object

Platform

object

Plss

object

Public Land Survey identity. Not unique: an aliquot can hold many parcels.

Precision

object

What the coordinate actually is. Decides which grains we will answer at.

PrecisionFloor

object

PrivateRestriction

object

A recorded restriction that binds the land whatever the zoning says. Never public law.

Process

object

One kind of application or permit, with everything it takes.

Property

object

The public-record profile of a property, with its record layers on request.

Proposal

object

What you intend to build, in feet and square feet. Anything you omit is not evaluated.

Proposed

object

Provenance

object

How we obtained a document. Always embedded, never its own endpoint.

PublicNotice

object

A published notice, which appears before a hearing or adoption.

Purpose

object

Ratio

object

'One stall per 200 sqft of gross floor area': per_value 200, per_unit sqft, per_basis gross_floor_area.

RebuildRight

object

May this be rebuilt after a casualty. A quoted sentence of the ordinance, with its own citation.

Recorded

object

Recording

object

Where an instrument sits in the recorder's books.

Region

object

RegionBody

object

RegionCoverage

object

RegionMember

object

RegionPatch

object

RegionalPermission

object

A permission row found by a question that spans jurisdictions.

RegisterClientRequest

object

RFC 7591 Dynamic Client Registration. Deprecated by MCP; kept as fallback.

Relationship

object

RequestEcho

object

Required

object

Requirement

object

Resolution

object

How the location in the request became a place. Ambiguity is returned, never guessed.

RetryPolicy

object

Review

object

ReviewClock

object

ReviewStep

object

Rollup

object

Coverage counted by governments and by people, because either alone flatters.

RuleAnswer

object

Every rule at a location on a date. Zeroes are typed in layer[], never omitted.

RuleBatchAnswer

object

RuleBatchItem

object

RuleBatchRequest

object

SearchCorpus

object

SearchScope

object

Exactly what was searched.

Section

object

A structural unit of a code. Its citation is ready to quote.

SectionOutline

object

SectionRef

object

Structured section reference, with the jurisdiction's own rendering in label.

SectionSearch

object

Section search carries its denominator: exactly which text was searched.

Service

object

Who answered.

Session

object

A signed-in person, and the token that says so.

Setback

object

SignInRequest

object

SignUpRequest

object

Single_Alert_

object

Single_AnswerReceipt_

object

Single_Case_

object

Single_ChangeEvent_

object

Single_Citation_

object

Single_Code_

object

Single_Correction_

object

Single_Delivery_

object

Single_District_

object

Single_Document_

object

Single_Extract_

object

Single_Inquiry_

object

Single_Meeting_

object

Single_Moratorium_

object

Single_Ordinance_

object

Single_Parcel_

object

Single_Permit_

object

Single_Process_

object

Single_Property_

object

Single_Region_

object

Single_Section_

object

Single_Transaction_

object

Single_Version_

object

Single_Vocabulary_

object

Single_Webhook_

object

Source

object

SpecialDistrict

object

Historic, airport, floodplain and similar districts, each with its own authority.

StaffReport

object

StaffStatement

object

StatutoryClock

object

Structure

object

A building or improvement, from assessor building cards, footprints and permits.

Subscription

object

What this organization is on, and what it has.

Suggestion

object

A typeahead result that is a ready-to-send query, not a label.

SuggestionAnswer

object

SupersessionRisk

object

TableCell

object

Tally

object

Tax

object

One tax bill.

Threshold

object

What triggers a permit: 'over 200 square feet'.

TileJSON

object

TileJSON 3.0, plus what is in view and what is not.

TopUpRequest

object

Transaction

object

A recorded instrument that transfers or encumbers an interest.

UsageSummary

object

Everything the usage screen draws, in one call.

UseRef

object

A normalized land use, with the town's own term for it where one exists.

ValidationError

object

Valued

object

A money value that may be undisclosed.

VerificationRequest

object

Version

object

A retained snapshot. Re-extraction with a better engine is a new version; old citations still resolve.

Violation

object

A recorded code enforcement instrument against the property.

Vocabulary

object

VocabularyEntry

object

VocabularySummary

object

Vote

object

Webhook

object

WebhookBody

object

WebhookPatch

object

ZoningAt

object

The district in force at a record's own date. Derived, never quoted.

billing__Plan

object

corpus__Plan

object

parcel__ParcelKey

object

practice__Party

object

usage__Point

object

One day.

envelope__Page

object

envelope__ParcelKey

object

envelope__Party

object

A name on a public record, shown only as the source shows it.

envelope__Point

object

envelope__Total

object

paging__Page

object

Where this page sits in the result set.

paging__Total

object

How many rows matched, and whether that number is exact.

Which operation returns which

Next

Ask about a place

10 operations: place, rule, conformance, parcel.