Get comment

get
https://api.box.com/2.0
/comments/:comment_id

Retrieves the message and metadata for a specific comment, as well as information on the user who created the comment.

Request

application/json

Path Parameters

stringin pathrequired
12345

The ID of the comment.

Query Parameters

string arrayin queryoptional
id,type,name

A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.

Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.

Response

application/jsonComment

Returns a full comment object.

You can now try out some of our APIs live, right here in the documentation.
Log In

Request Example

cURL
curl -X GET https://api.box.com/2.0/comments/12345 \
     -H "Authorization: Bearer <ACCESS_TOKEN>"
.NET
BoxComment comment = await client.CommentsManager.GetInformationAsync(id: "11111");
Java
BoxComment comment = new BoxComment(api, "id");
BoxComment.Info info = comment.getInfo();
Node
client.comments.get('11111')
    .then(comment => {
        /* comment -> {
            type: 'comment',
            id: '11111',
            is_reply_comment: false,
            message: 'Great work!',
            created_by: 
            { type: 'user',
                id: '22222',
                name: 'Example User',
                login: 'user@example.com' },
            created_at: '2012-12-12T11:25:01-08:00',
            item: { id: '33333', type: 'file' },
            modified_at: '2012-12-12T11:25:01-08:00' }
        */
    });

Response Example

{
  "id": 11446498,
  "type": "comment",
  "is_reply_comment": true,
  "message": "@Aaron Levie these tigers are cool!",
  "created_by": {
    "id": 11446498,
    "type": "user",
    "name": "Aaron Levie",
    "login": "ceo@example.com"
  },
  "created_at": "2012-12-12T10:53:43-08:00",
  "modified_at": "2012-12-12T10:53:43-08:00",
  "item": {
    "id": 11446498
  },
  "tagged_message": "@[1234567:Aaron Levie] these tigers are cool!"
}