Home/API & Data/Data Dictionary
SCHEMA REFERENCE · 6 ENTITIES

Data Dictionary

Field-level documentation for every entity in the unified dataset. Fields are classified as base (always served) or contact (PII — contact-tier entitlement required).

baseIncluded in every entitled API response and bulk export — no PII, always served.
contactContact-PII fields. Requires contact-tier field entitlement in your account scope.

The core permit record from municipal portals. Each row represents one permit application.

FieldTypeTierDescription
bm_permit_iduuidbaseBuilders Monitor internal permit UUID.
bm_job_iduuidbaseJob/project grouping key (one job may have multiple permits).
bm_property_iduuidbaseForeign key to the property record.
permit_numbertextbaseSource permit number as issued by the jurisdiction.
parent_permit_numbertextbaseParent permit for sub-permits.
permit_typetextbaseCanonical permit type (e.g. Building, Electrical, Plumbing).
permit_subtypetextbaseSub-classification within the permit type.
work_classtextbaseWork classification (e.g. New Construction, Addition, Repair).
descriptiontextbaseFree-text description of the permitted work.
valuationnumericbaseDeclared project valuation in USD.
feenumericbaseTotal permit fee charged.
sqftnumericbaseSquare footage of the permitted work.
unitsintegerbaseNumber of dwelling units.
storiesintegerbaseNumber of stories.
applied_datedatebaseDate the permit application was submitted.
issued_datedatebaseDate the permit was issued/approved.
completed_datedatebaseDate construction was completed.
expires_datedatebasePermit expiration date.
citytextbaseMunicipality (from the joined property record).
statetextbase2-letter US state code.
ziptextbaseZIP code.
countytextbaseCounty name.
longitudefloatbaseGeocoded longitude (WGS84).
latitudefloatbaseGeocoded latitude (WGS84).
parcel_idtextbaseAssessor parcel number (APN).
addresstextcontactFull street address (contact tier — re-identifies location).
address_rawtextcontactAddress as supplied by the source portal (contact tier).
street_numbertextcontactStreet number component (contact tier).
street_nametextcontactStreet name component (contact tier).
unittextcontactUnit/suite component (contact tier).

People and organizations named on permits as contractors, applicants, owners, or other roles. Sourced from permit contacts and certifications.

FieldTypeTierDescription
bm_entity_iduuidbaseBuilders Monitor entity UUID (deduplicated person/org).
bm_source_idintegerbaseSource jurisdiction ID.
kindtextbaseEntity type: person or organization.
license_statetextbaseState that issued the license.
license_typetextbaseLicense type (e.g. General Contractor, Electrical, Plumbing).
license_classtextbaseLicense classification.
license_statustextbaseLicense status (active, expired, suspended, etc.).
license_expirydatebaseLicense expiration date.
citytextbaseCity of the business address.
statetextbaseState of the business address.
entity_nametextcontactOrganization name (contact tier — PII).
first_nametextcontactFirst name (contact tier — PII).
last_nametextcontactLast name (contact tier — PII).
phonetext[]contactPhone numbers array (contact tier — PII).
emailtext[]contactEmail addresses array (contact tier — PII).
license_numbertextcontactLicense number (contact tier — PII).
addresstextcontactBusiness address (contact tier — PII).
roletextcontactRole on the permit (e.g. Contractor, Applicant, Owner).

Individual inspection events linked to a permit. Each row is one scheduled or completed inspection.

FieldTypeTierDescription
bm_inspection_iduuidbaseBuilders Monitor inspection UUID.
bm_permit_iduuidbaseParent permit UUID.
bm_source_idintegerbaseSource jurisdiction ID.
inspection_typetextbaseCanonical inspection type (e.g. Framing, Electrical Rough, Final).
categorytextbaseInspection discipline category.
statustextbaseInspection status (Scheduled, Passed, Failed, Cancelled).
outcometextbaseResult outcome if completed.
scheduled_datedatebaseScheduled inspection date.
actual_datedatebaseActual inspection date.
is_reinspectionbooleanbaseTrue if this is a re-inspection.
inspector_nametextcontactInspector full name (contact tier — PII).
inspector_emailtextcontactInspector email address (contact tier — PII).
commentstextcontactInspector comments on the inspection result (contact tier).

Individual fee line items assessed against a permit.

FieldTypeTierDescription
bm_fee_iduuidbaseBuilders Monitor fee UUID.
bm_permit_iduuidbaseParent permit UUID.
bm_source_idintegerbaseSource jurisdiction ID.
fee_typetextbaseCanonical fee category (e.g. Plan Check, Inspection, Impact).
amountnumericbaseFee amount in USD.
inserted_attimestamptzbaseRow insertion timestamp.

Code-enforcement violations linked to a permit or property. Currently a forward-looking spec; populated as coverage expands.

FieldTypeTierDescription
bm_violation_iduuidbaseBuilders Monitor violation UUID.
bm_permit_iduuidbaseAssociated permit UUID.
violation_codetextbaseViolation code as cited.
violation_descriptiontextbaseDescription of the cited violation.
statustextbaseViolation status (Open, Resolved, Dismissed).
violation_datedatebaseDate the violation was cited.
inspector_nametextcontactInspector who cited the violation (contact tier — PII).

Documents and files attached to a permit (plans, certificates, photos). Metadata only — file bytes are not served through the API.

FieldTypeTierDescription
bm_attachment_iduuidbaseBuilders Monitor attachment UUID.
bm_permit_iduuidbaseParent permit UUID.
filenametextbaseOriginal filename.
file_typetextbaseMIME type or file extension.
document_typetextbaseDocument category (e.g. Plan, Certificate, Photo).
file_sizebigintbaseFile size in bytes.
urltextbaseSource URL (may require authentication at the origin portal).
upload_datedatebaseDate the document was uploaded.
Bulk export columns (permits — base tier)
bm_permit_id, permit_number, permit_type, permit_subtype, description, valuation, applied_date, issued_date, updated_at, address, city, state, zip, longitude, latitude
The exports endpoint (POST /v1/exports) currently supports the permits category. Additional categories are available via the bulk-surface entitlement as coverage expands.