Deals | RetailHardHat REST API docs

Supported operations

Method	Path	Description
GET	`/api/v1/deals`	List all deals
GET	`/api/v1/deals/:id`	Get a deal by ID
POST	`/api/v1/deals`	Create a new deal
PATCH	`/api/v1/deals/:id`	Update a deal
DELETE	`/api/v1/deals/:id`	Delete a deal

Example request

Replace YOUR_API_KEY with a private key stored in your environment. Replace path parameters with records from your organization.

curl --request GET "/api/v1/deals" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Accept: application/json"

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
`assetType`	`enum`	Optional	asset Type Values: `retail`, `restaurant`, `qsr`, `convenience`, `gas_station`, `mixed_use`, `pad_site`, `inline`, `endcap`, `freestanding`, `other`
`address`	`string`	Optional	address
`address2`	`string`	Optional	address2
`city`	`string`	Optional	city
`state`	`string`	Optional	state
`zipCode`	`string`	Optional	zip Code
`sponsor`	`string`	Optional	sponsor
`source`	`enum`	Optional	source Values: `broker`, `off_market`, `internal`, `referral`, `auction`, `other`
`stage`	`enum`	Optional	stage Values: `prospect`, `loi`, `psa`, `due_diligence`, `closing`, `closed`, `dead`, `sourcing`, `screening`
`stageEntryDate`	`datetime`	Optional	stage Entry Date
`ownerId`	`uuid`	Optional	owner Id Related resource: `users`
`loiDate`	`datetime`	Optional	loi Date
`psaExecutionDate`	`datetime`	Optional	psa Execution Date
`ddExpirationDate`	`datetime`	Optional	dd Expiration Date
`closingTargetDate`	`datetime`	Optional	closing Target Date
`notes`	`string`	Optional	notes
`commissionRate`	`string`	Optional	commission Rate
`estimatedValue`	`number`	Optional	estimated Value
`squareFootage`	`number`	Optional	square Footage
`advanceProbability`	`number`	Optional	advance Probability
`closeProbability`	`number`	Optional	close Probability
`isProbabilityAutoCalculated`	`boolean`	Optional	is Probability Auto Calculated
`probabilityOverrideJustification`	`string`	Optional	probability Override Justification
`nextAction`	`string`	Optional	next Action
`nextActionDueDate`	`datetime`	Optional	next Action Due Date
`lastActivityAt`	`datetime`	Optional	last Activity At
`siteId`	`uuid`	Optional	site Id Related resource: `sites`
`brokerId`	`uuid`	Optional	broker Id
`demographics`	`json`	Optional	demographics
`createdAt`	`datetime`	Optional	Creation timestamp (auto)
`updatedAt`	`datetime`	Optional	Last update timestamp (auto)