RetailHardHat Developer docs

REST API documentation

Document Folders

Folder structure for organizing site documents

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)
siteIduuidOptionalsite Id

Related resource: sites

parentFolderIduuidOptionalparent Folder Id

Related resource: documentFolders

namestringRequiredname
scopeenumOptionalscope

Values: site, tenant

pathstringOptionalpath
sortOrdernumberOptionalsort Order
isConfidentialbooleanOptionalis Confidential
showInPortalbooleanOptionalshow In Portal
portalVisibilityenumOptionalportal Visibility

Values: all_vendors, specific_vendors

createdBystringOptionalcreated By
createdAtdatetimeOptionalCreation timestamp (auto)
updatedAtdatetimeOptionalLast update timestamp (auto)