RetailHardHat Developer docs

REST API documentation

Rfps

Requests for proposals sent to vendors for site work

Supported operations

MethodPathDescription
GET/api/v1/rfpsList all rfps
GET/api/v1/rfps/:idGet a rfp by ID
POST/api/v1/rfpsCreate a new rfp
PATCH/api/v1/rfps/:idUpdate a rfp
DELETE/api/v1/rfps/:idDelete a rfp

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/rfps" \
  --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.

FieldTypeModel requirementDescription
idstringOptionalUnique identifier (auto-generated)
siteIduuidOptionalsite Id

Related resource: sites

titlestringRequiredtitle
descriptionstringOptionaldescription
categorystringRequiredcategory
scopeTypeenumOptionalscope Type

Values: site, portfolio

scopeSummarystringOptionalscope Summary
requirementsstringOptionalrequirements
issueDatedatetimeRequiredissue Date
responseDeadlinedatetimeRequiredresponse Deadline
budgetTargetstringOptionalbudget Target
evaluationCriteriastringOptionalevaluation Criteria
statusenumOptionalstatus

Values: draft, published, evaluating, awarded, cancelled

winningBidIduuidOptionalwinning Bid Id
awardedAtdatetimeOptionalawarded At
generatedDocumentjsonOptionalgenerated Document
generatedAtdatetimeOptionalgenerated At
createdAtdatetimeOptionalCreation timestamp (auto)
updatedAtdatetimeOptionalLast update timestamp (auto)