---
title: "List file comments"
method: GET
path: "/files/{file_id}/comments"
tags: ["Comments"]
---

# List file comments

`GET /files/{file_id}/comments`

Retrieves a list of comments for a file.

## Path parameters

- `file_id` string, required

## Query parameters

- `fields` string[]
- `limit` integer
- `offset` integer

## Response `200`

Returns a collection of comment objects. If there are no
comments on this file an empty collection will be returned.

- Comments — The part of an API response that describes pagination.
  - `total_count` integer — One greater than the offset of the last entry in the entire collection. The total number of entries in the collection may be less than `total_count`. This field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.
  - `limit` integer — The limit that was used for these entries. This will be the same as the `limit` query parameter unless that value exceeded the maximum value allowed. The maximum value varies by API.
  - `offset` integer — The 0-based offset of the first entry in this set. This will be the same as the `offset` query parameter. This field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.
  - `order` object[] — The order by which items are returned. This field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.
    - `by` string — The field to order by.
    - `direction` 'ASC' | 'DESC' — The direction to order by, either ascending or descending.
  - `entries` CommentFull[] — A list of comments.
    - `id` string — The unique identifier for this comment.
    - `type` 'comment' — The value will always be `comment`.
    - `is_reply_comment` boolean — Whether or not this comment is a reply to another comment.
    - `message` string — The text of the comment, as provided by the user.
    - `created_by` object — A mini user object representing the author of the comment.
      - `id` string, required — The unique identifier for this user.
      - `type` 'user', required — The value will always be `user`.
      - `name` string — The display name of this user.
      - `login` string, email — The primary email address of this user.
    - `created_at` string, date-time — The time this comment was created.
    - `modified_at` string, date-time — The time this comment was last modified.
    - `item` object — The file this comment was placed on.
      - `id` string — The unique identifier for this object.
      - `type` string — The type for this object.
    - `tagged_message` string — 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.

## Other responses

- `default` — An unexpected client error.

---

[API](https://skmtc.net/box/apis/platform-api.md) · [All operations](https://skmtc.net/box/apis/platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/box/platform-api/revisions/ba8f087e1a4d/schema)
