RetailHardHat Developer docs

REST API documentation

Vendor Workers

Individual workers/employees of vendor companies

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)
vendorIduuidRequiredvendor Id

Related resource: vendors

firstNamestringRequiredfirst Name
lastNamestringOptionallast Name
rolestringOptionalrole
emailstringOptionalemail
phonestringOptionalphone
certificationsstringOptionalcertifications
notesstringOptionalnotes
isActivebooleanOptionalis Active
portalInvitedAtdatetimeOptionalportal Invited At
createdAtdatetimeOptionalCreation timestamp (auto)
updatedAtdatetimeOptionalLast update timestamp (auto)