List file comments
GET https://{{api.box.com}}/2.0/files/:file_id/comments
Retrieves a list of comments for a file.
https://developer.box.com/reference/get-files-id-comments
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
fields | string | 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. |
| limit
| number | | The maximum number of items to return per page. |
| offset
| number | | The offset of the item at which to begin the response.
Queries with offset parameter value exceeding 10000 will be rejected with a 400 response. |
RESPONSES
status: OK
{"total_count":5000,"limit":1000,"offset":2000,"order":[{"by":"type","direction":"ASC"}],"entries":[{"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","type":"file"},"tagged_message":"@[1234567:Aaron Levie] these tigers are cool!"}]}