Box Developer Documentation
Log in

Comment

Comments are messages created on files. Comments can be made independently or created as responses to other comments

Base
Mini
Standard

This resource has a few variations that can be encountered when using the API.

The fields that are part of the standard variant are generally returned when the resource is requested via its own API endpoints. For example, when retrieving a file by ID, it will return these fields unless the fields parameter has been specified.

string
11446498

The unique identifier for this object

string
comment

Value is always comment

string / date-time
2012-12-12T10:53:43-08:00

The time this comment was created

User (Mini) object

A mini user object representing the author of the comment

boolean
true

Whether or not this comment is a reply to another comment

object

The object this comment was placed on

string
11446498

The unique identifier for this object

string
@Aaron Levie these tigers are cool!

The text of the comment, as provided by the user

string / date-time
2012-12-12T10:53:43-08:00

The time this comment was last modified

Full

Response Example

{
  "created_at": "2012-12-12T10:53:43-08:00",
  "created_by": {
    "id": 11446498,
    "login": "ceo@example.com",
    "name": "Aaron Levie",
    "type": "user"
  },
  "id": 11446498,
  "is_reply_comment": true,
  "item": {
    "id": 11446498
  },
  "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!",
  "type": "comment"
}