RetailHardHat Developer docs

REST API documentation

Permit Documents

Documents attached to permits

Supported operations

This resource provides field metadata only. No dedicated CRUD endpoint is advertised.

Field reference

Required means required by the underlying data model, not necessarily caller-supplied. The server derives protected identity and ownership fields; endpoint validation controls which fields are accepted. Sensitive credential fields are omitted here.

FieldTypeModel requirementDescription
idstringOptionalUnique identifier (auto-generated)
permitIduuidRequiredpermit Id

Related resource: permits

namestringRequiredname
documentTypeenumRequireddocument Type

Values: application, approval, correspondence, fee_receipt, inspection_report, amendment, other

uploadedDatedatetimeOptionaluploaded Date
fileUrlstringOptionalfile Url
fileSizenumberOptionalfile Size
notesstringOptionalnotes
createdAtdatetimeOptionalCreation timestamp (auto)
updatedAtdatetimeOptionalLast update timestamp (auto)