Skip to navigation

Notes on files

New: GET and POST /files/{file_id}/notes

You can now read and add notes (comments) on files, the same way you can on projects and work orders.

  • GET /files/{file_id}/notes lists a file’s notes, newest first, with page and page_size (max 100).
  • POST /files/{file_id}/notes adds a note. Send body, and optionally replyToId to reply to a note on the same file, or fileIds to attach files.

To @mention someone, put a token in body, for example Please review [Nicolaus Copernicus|~id:99001]. Mentioned users get a notification, as they do for notes made in Coperniq.

Edit or delete a file note with PATCH and DELETE /notes/{note_id}, like any other note. A file that isn’t in your company returns 404.

Notes: replies in lists, pagination, and edit responses

Updated: notes lists return replyToId

Every notes list now returns replyToId on notes that are replies, so you can rebuild a thread. It is the ID of the note being replied to, and it is left out on top-level notes. This applies to the notes lists for projects, opportunities, accounts, work orders and files.

Docs: page and page_size on notes lists

The project, opportunity and account notes lists accept page and page_size (default 20, max 100), like the work order and file notes lists. They always worked. They are now documented.

Fixed: PATCH /notes/{note_id} response

Editing a note returned { "note": "" } even though the edit was saved. It now returns the edited note with its id, createdAt, updatedAt, and replyToId for replies.