RetailHardHat Developer docs

REST API documentation

Deal History

Audit trail of changes to deals

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

Related resource: deals

userIduuidOptionaluser Id

Related resource: users

actionstringRequiredaction
fieldNamestringOptionalfield Name
oldValuestringOptionalold Value
newValuestringOptionalnew Value
fromStageenumOptionalfrom Stage

Values: prospect, loi, psa, due_diligence, closing, closed, dead, sourcing, screening

toStageenumOptionalto Stage

Values: prospect, loi, psa, due_diligence, closing, closed, dead, sourcing, screening

notesstringOptionalnotes
createdAtdatetimeOptionalCreation timestamp (auto)