Available since FileRun 2026.3.0.
| Target URL (list) | /api.php/Drive/files/comments/list |
| Target URL (add) | /api.php/Drive/files/comments/add |
| Target URL (delete) | /api.php/Drive/files/comments/delete |
| Required scope | comments |
| HTTP Method | POST |
| Output format | JSON |
Comments can be written on files and on folders. Reading comments requires the account permission to read comments. Writing and deleting them requires the permission to write comments. On a shared item, the share role needs to allow comments (commenter or higher).
| Parameter | Type | Required | Description |
|---|---|---|---|
| path | string | Yes | The FileRun path of the file or folder. See this page |
The response carries the comments in the data array, oldest first. Each entry has the following fields:
| Field | Type | Description |
|---|---|---|
| id | integer | The id of the comment |
| date_added | integer | Unix timestamp of the moment the comment was written |
| public_id | string | The public id of the author |
| full_name | string | The full name of the author |
| comment | string | The text of the comment, as it was written |
| Parameter | Type | Required | Description |
|---|---|---|---|
| path | string | Yes | The FileRun path of the file or folder. See this page |
| comment | string | Yes | The text of the comment. |
The response carries the id of the new comment as data.id.
| Parameter | Type | Required | Description |
|---|---|---|---|
| path | string | Yes | The FileRun path of the file or folder the comment was written on. See this page |
| commentId | integer | Yes | The id of the comment, as returned by the listing. |
The comment must have been written on the item named by path. Otherwise the request is refused. On an item shared with you, you can delete only your own comments.