Change Requests | RetailHardHat REST API docs

Supported operations

Method	Path	Description
GET	`/api/v1/change-requests`	List all change requests
GET	`/api/v1/change-requests/:id`	Get a change request by ID
POST	`/api/v1/change-requests`	Create a new change request
PATCH	`/api/v1/change-requests/:id`	Update a change request
DELETE	`/api/v1/change-requests/:id`	Delete a change request

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/change-requests" \
  --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`
`bidId`	`uuid`	Optional	bid Id Related resource: `bids`
`dealBudgetLineItemId`	`uuid`	Optional	deal Budget Line Item Id
`requestNumber`	`string`	Required	request Number
`title`	`string`	Required	title
`scopeDescription`	`string`	Required	scope Description
`costImpact`	`string`	Required	cost Impact
`scheduleImpactDays`	`number`	Optional	schedule Impact Days
`scheduleImpactDescription`	`string`	Optional	schedule Impact Description
`status`	`enum`	Optional	status Values: `draft`, `submitted`, `under_review`, `approved`, `rejected`, `implemented`
`requestedByUserId`	`uuid`	Required	requested By User Id Related resource: `users`
`requestedAt`	`datetime`	Optional	requested At
`submittedAt`	`datetime`	Optional	submitted At
`approvedAt`	`datetime`	Optional	approved At
`implementedAt`	`datetime`	Optional	implemented At
`budgetImpactApplied`	`boolean`	Optional	budget Impact Applied
`relatedFinancialPlanId`	`uuid`	Optional	related Financial Plan Id
`notes`	`string`	Optional	notes
`createdAt`	`datetime`	Optional	Creation timestamp (auto)
`updatedAt`	`datetime`	Optional	Last update timestamp (auto)