Criteria Profiles | RetailHardHat REST API docs

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.

Field	Type	Model requirement	Description
`id`	`string`	Optional	Unique identifier (auto-generated)
`name`	`string`	Required	name
`description`	`string`	Optional	description
`stakeholderType`	`enum`	Optional	stakeholder Type Values: `investor`, `lender`, `partner`, `internal`, `other`
`status`	`enum`	Optional	status Values: `draft`, `active`, `inactive`, `archived`
`stakeholderName`	`string`	Optional	stakeholder Name
`stakeholderCompany`	`string`	Optional	stakeholder Company
`stakeholderEmail`	`string`	Optional	stakeholder Email
`stakeholderPhone`	`string`	Optional	stakeholder Phone
`stakeholderContactId`	`uuid`	Optional	stakeholder Contact Id
`version`	`number`	Optional	version
`isCurrent`	`boolean`	Optional	is Current
`parentProfileId`	`uuid`	Optional	parent Profile Id
`minIrr`	`string`	Optional	min Irr
`targetIrr`	`string`	Optional	target Irr
`maxIrr`	`string`	Optional	max Irr
`irrConstraint`	`enum`	Optional	irr Constraint Values: `required`, `preferred`
`minEquityMultiple`	`string`	Optional	min Equity Multiple
`targetEquityMultiple`	`string`	Optional	target Equity Multiple
`equityMultipleConstraint`	`enum`	Optional	equity Multiple Constraint Values: `required`, `preferred`
`minCashOnCash`	`string`	Optional	min Cash On Cash
`targetCashOnCash`	`string`	Optional	target Cash On Cash
`cashOnCashConstraint`	`enum`	Optional	cash On Cash Constraint Values: `required`, `preferred`
`minYieldOnCost`	`string`	Optional	min Yield On Cost
`targetYieldOnCost`	`string`	Optional	target Yield On Cost
`yieldOnCostConstraint`	`enum`	Optional	yield On Cost Constraint Values: `required`, `preferred`
`minEquityCheck`	`string`	Optional	min Equity Check
`maxEquityCheck`	`string`	Optional	max Equity Check
`targetEquityCheck`	`string`	Optional	target Equity Check
`equityCheckConstraint`	`enum`	Optional	equity Check Constraint Values: `required`, `preferred`
`minTotalProjectSize`	`string`	Optional	min Total Project Size
`maxTotalProjectSize`	`string`	Optional	max Total Project Size
`totalProjectSizeConstraint`	`enum`	Optional	total Project Size Constraint Values: `required`, `preferred`
`maxLeverageRatio`	`string`	Optional	max Leverage Ratio
`preferredLeverageRatio`	`string`	Optional	preferred Leverage Ratio
`leverageConstraint`	`enum`	Optional	leverage Constraint Values: `required`, `preferred`
`minHoldPeriodMonths`	`number`	Optional	min Hold Period Months
`maxHoldPeriodMonths`	`number`	Optional	max Hold Period Months
`targetHoldPeriodMonths`	`number`	Optional	target Hold Period Months
`holdPeriodConstraint`	`enum`	Optional	hold Period Constraint Values: `required`, `preferred`
`assetTypes`	`array`	Optional	asset Types
`assetTypesConstraint`	`enum`	Optional	asset Types Constraint Values: `required`, `preferred`
`excludedAssetTypes`	`array`	Optional	excluded Asset Types
`countries`	`array`	Optional	countries
`states`	`array`	Optional	states
`metros`	`array`	Optional	metros
`submarkets`	`array`	Optional	submarkets
`geographyConstraint`	`enum`	Optional	geography Constraint Values: `required`, `preferred`
`excludedGeographies`	`array`	Optional	excluded Geographies
`dealTypes`	`array`	Optional	deal Types
`dealTypesConstraint`	`enum`	Optional	deal Types Constraint Values: `required`, `preferred`
`excludedDealTypes`	`array`	Optional	excluded Deal Types
`riskTolerance`	`enum`	Optional	risk Tolerance Values: `conservative`, `moderate`, `aggressive`, `opportunistic`
`holdPeriodPreference`	`enum`	Optional	hold Period Preference Values: `short_term`, `medium_term`, `long_term`, `flexible`
`sponsorPreferences`	`string`	Optional	sponsor Preferences
`returnRiskTradeoff`	`string`	Optional	return Risk Tradeoff
`esgImpactGoals`	`string`	Optional	esg Impact Goals
`exclusions`	`string`	Optional	exclusions
`additionalNotes`	`string`	Optional	additional Notes
`sourceType`	`enum`	Optional	source Type Values: `call`, `email`, `meeting`, `document`, `lp_agreement`, `term_sheet`, `mandate_letter`, `website`, `referral`, `other`
`sourceNotes`	`string`	Optional	source Notes
`sourceDate`	`string`	Optional	source Date
`sourceContact`	`string`	Optional	source Contact
`isValidated`	`boolean`	Optional	is Validated
`validatedAt`	`datetime`	Optional	validated At
`validatedBy`	`string`	Optional	validated By
`validationNotes`	`string`	Optional	validation Notes
`completenessScore`	`number`	Optional	completeness Score
`missingRequiredFields`	`array`	Optional	missing Required Fields
`createdBy`	`string`	Optional	created By
`updatedBy`	`string`	Optional	updated By
`createdAt`	`datetime`	Optional	Creation timestamp (auto)
`updatedAt`	`datetime`	Optional	Last update timestamp (auto)
`archivedAt`	`datetime`	Optional	archived At
`archivedBy`	`string`	Optional	archived By