Bids | RetailHardHat REST API docs

Supported operations

Method	Path	Description
GET	`/api/v1/bids`	List all bids
GET	`/api/v1/bids/:id`	Get a bid by ID
POST	`/api/v1/bids`	Create a new bid
PATCH	`/api/v1/bids/:id`	Update a bid
DELETE	`/api/v1/bids/:id`	Delete a bid
GET	`/api/v1/bids/:bidId/contacts`	List contacts for a bid
POST	`/api/v1/bids/:bidId/contacts`	Add a contact to a bid
PATCH	`/api/v1/bids/:bidId/contacts/:id`	Update a bid contact
DELETE	`/api/v1/bids/:bidId/contacts/:id`	Delete a bid contact

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/bids" \
  --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)
`siteId`	`uuid`	Optional	site Id Related resource: `sites`
`projectId`	`uuid`	Optional	project Id
`rfpId`	`uuid`	Optional	rfp Id Related resource: `rfps`
`budgetPlanId`	`uuid`	Optional	budget Plan Id
`vendorId`	`uuid`	Optional	vendor Id Related resource: `vendors`
`dealBudgetLineItemId`	`uuid`	Optional	deal Budget Line Item Id
`contractor`	`string`	Required	contractor
`category`	`string`	Required	category
`amount`	`string`	Required	amount
`originalContractAmount`	`string`	Optional	original Contract Amount
`forecastedAmount`	`string`	Optional	forecasted Amount
`finalActualCost`	`string`	Optional	final Actual Cost
`status`	`enum`	Optional	status Values: `pending`, `under_review`, `approved`, `rejected`
`contractStatus`	`enum`	Optional	contract Status Values: `none`, `negotiating`, `pending_signature`, `signed`, `executed`, `terminated`
`submittedDate`	`datetime`	Required	submitted Date
`dueDate`	`datetime`	Optional	due Date
`documents`	`number`	Optional	documents
`notes`	`string`	Optional	notes
`contactName`	`string`	Optional	contact Name
`contactEmail`	`string`	Optional	contact Email
`contactPhone`	`string`	Optional	contact Phone
`leasecommandContractId`	`uuid`	Optional	leasecommand Contract Id
`createdAt`	`datetime`	Optional	Creation timestamp (auto)
`updatedAt`	`datetime`	Optional	Last update timestamp (auto)