Rfis | RetailHardHat REST API docs

Supported operations

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

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/rfis" \
  --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`	Required	site Id Related resource: `sites`
`rfiNumber`	`number`	Required	rfi Number
`title`	`string`	Required	title
`question`	`string`	Required	question
`category`	`enum`	Optional	category Values: `design_clarification`, `field_condition`, `conflict`, `missing_detail`, `substitution_request`, `code_interpretation`, `schedule_coordination`, `other`
`priority`	`enum`	Optional	priority Values: `low`, `medium`, `high`, `critical`
`status`	`enum`	Optional	status Values: `draft`, `open`, `under_review`, `answered`, `closed`, `void`
`drawingReferences`	`json`	Optional	drawing References
`specSections`	`string`	Optional	spec Sections
`building`	`string`	Optional	building
`level`	`string`	Optional	level
`area`	`string`	Optional	area
`assignedToId`	`uuid`	Optional	assigned To Id Related resource: `users`
`dueDate`	`string`	Optional	due Date
`responseRequiredDate`	`string`	Optional	response Required Date
`submittedAt`	`datetime`	Optional	submitted At
`answeredAt`	`datetime`	Optional	answered At
`closedAt`	`datetime`	Optional	closed At
`costImpact`	`enum`	Optional	cost Impact Values: `none`, `unknown`, `estimated`, `confirmed`
`costImpactAmount`	`string`	Optional	cost Impact Amount
`scheduleImpactDays`	`number`	Optional	schedule Impact Days
`scopeImpact`	`enum`	Optional	scope Impact Values: `clarification`, `change`, `substitution`, `no_impact`
`submittedByVendorId`	`uuid`	Optional	submitted By Vendor Id
`submittedByTrade`	`string`	Optional	submitted By Trade
`isInternalOnly`	`boolean`	Optional	is Internal Only
`visibleToVendorIds`	`array`	Optional	visible To Vendor Ids
`isLocked`	`boolean`	Optional	is Locked
`lockedAt`	`datetime`	Optional	locked At
`lockedById`	`uuid`	Optional	locked By Id
`tags`	`array`	Optional	tags
`customFields`	`json`	Optional	custom Fields
`createdAt`	`datetime`	Optional	Creation timestamp (auto)
`updatedAt`	`datetime`	Optional	Last update timestamp (auto)