Enterprise Leads | 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)
`firstName`	`string`	Required	first Name
`lastName`	`string`	Required	last Name
`email`	`string`	Required	email
`phone`	`string`	Optional	phone
`companyName`	`string`	Required	company Name
`jobTitle`	`string`	Optional	job Title
`numberOfLocations`	`string`	Optional	number Of Locations
`industry`	`string`	Optional	industry
`message`	`string`	Optional	message
`status`	`enum`	Optional	status Values: `new`, `contacted`, `qualified`, `demo_scheduled`, `proposal_sent`, `negotiating`, `closed_won`, `closed_lost`
`source`	`string`	Optional	source
`utmSource`	`string`	Optional	utm Source
`utmMedium`	`string`	Optional	utm Medium
`utmCampaign`	`string`	Optional	utm Campaign
`notes`	`string`	Optional	notes
`assignedTo`	`string`	Optional	assigned To
`lastContactedAt`	`datetime`	Optional	last Contacted At
`createdAt`	`datetime`	Optional	Creation timestamp (auto)
`updatedAt`	`datetime`	Optional	Last update timestamp (auto)