RetailHardHat Developer docs

REST API documentation

Permit Notes

Notes on permit applications and status

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

userIduuidRequireduser Id

Related resource: users

titlestringOptionaltitle
contentstringRequiredcontent
mentionedUserIdsarrayOptionalmentioned User Ids
createdAtdatetimeOptionalCreation timestamp (auto)
updatedAtdatetimeOptionalLast update timestamp (auto)