RetailHardHat Developer docs

REST API documentation

Approval Requests

Individual approval requests submitted for review

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.

FieldTypeModel requirementDescription
idstringOptionalUnique identifier (auto-generated)
flowIduuidRequiredflow Id

Related resource: approvalFlows

entityTypeenumRequiredentity Type

Values: bid, rfp, budget, invoice

entityIduuidRequiredentity Id
statusenumOptionalstatus

Values: pending, approved, rejected, cancelled

currentStepNumbernumberOptionalcurrent Step Number
submittedBystringRequiredsubmitted By
submittedAtdatetimeOptionalsubmitted At
completedAtdatetimeOptionalcompleted At
notesstringOptionalnotes
createdAtdatetimeOptionalCreation timestamp (auto)