RetailHardHat Developer docs

REST API documentation

Deal Stages

Custom deal pipeline stage definitions

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)
namestringRequiredname
slugstringRequiredslug
descriptionstringOptionaldescription
colorstringOptionalcolor
displayOrdernumberOptionaldisplay Order
isDefaultbooleanOptionalis Default
isClosedWonbooleanOptionalis Closed Won
isClosedLostbooleanOptionalis Closed Lost
agingThresholdDaysnumberOptionalaging Threshold Days
createdAtdatetimeOptionalCreation timestamp (auto)
updatedAtdatetimeOptionalLast update timestamp (auto)