RetailHardHat Developer docs

REST API documentation

Project Notes

Notes and comments attached to a project (accessed via /api/v1/projects/:id/notes)

Supported operations

MethodPathDescription
GET/api/v1/projects/:id/notesList notes on a project
POST/api/v1/projects/:id/notesAdd a note to a project
PATCH/api/v1/projects/:id/notes/:noteIdUpdate a project note
DELETE/api/v1/projects/:id/notes/:noteIdDelete a project note

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

Related resource: projects

userIduuidRequireduser Id

Related resource: users

titlestringOptionaltitle
contentstringRequiredcontent
mentionedUserIdsarrayOptionalmentioned User Ids
createdAtdatetimeOptionalCreation timestamp (auto)
updatedAtdatetimeOptionalLast update timestamp (auto)