Skip to main content
API version 2024.0 Comments are messages created on files. Comments can be made independently or created as responses to other comments.
This resource has a few variations that can be encountered when using the API.The fields that are part of the full variant can be returned by API endpoints that support the fields parameter. For example, by defining the fields request parameter as id,type when requesting a file by ID, only those fields will be returned in the API response.
​
id
string
example: 11446498The unique identifier for this comment.
​
type
string
example: commentThe value will always be comment.Value is always comment
​
created_at
string(date-time)
example: 2012-12-12T10:53:43-08:00The time this comment was created.
​
created_by
User (Mini)object
A mini user object representing the author of the comment.
​
is_reply_comment
boolean
example: trueWhether or not this comment is a reply to another comment.
​
item
object
The file this comment was placed on.
​
message
string
example: @Aaron Levie these tigers are cool!The text of the comment, as provided by the user.
​
modified_at
string(date-time)
example: 2012-12-12T10:53:43-08:00The time this comment was last modified.
​
tagged_message
string
example: @[1234567:Aaron Levie] these tigers are cool!The string representing the comment text with @mentions included. @mention format is @[id:username] where id is user’s Box ID and username is their display name.
{
  "id": "11446498",
  "type": "comment",
  "created_at": "2012-12-12T10:53:43-08:00",
  "created_by": {
    "id": "11446498",
    "type": "user",
    "login": "[email protected]",
    "name": "Aaron Levie"
  },
  "is_reply_comment": true,
  "item": {
    "id": "11446498",
    "type": "file"
  },
  "message": "@Aaron Levie these tigers are cool!",
  "modified_at": "2012-12-12T10:53:43-08:00",
  "tagged_message": "@[1234567:Aaron Levie] these tigers are cool!"
}