---
title: "List comments"
method: GET
path: "/documents/{document}/comments"
tags: ["Document Operations"]
---

# List comments

`GET /documents/{document}/comments`

<small>Requires an API token with the **Document Reader** role.</small>

Lists the comments that have been made on a [document](/#documents).

## Filtering

The comment list can be filtered by a number of different attributes. The available filter attributes are listed
under `filter` in the [Query Parameters](/operations/v1.documents.comments.index#Query-Parameters) section of
this page.

To specify filters, use array notation in the request query string to specify one or more `filter` values.

For example, to filter for externally-visible comments that have not been marked as resolved, the query string
should contain:

`filter[scope]=internal_and_external&filter[resolution_status]=open`

## Path parameters

- `document` string, required

## Query parameters

- `filter[resolution_status]` 'open' | 'resolved'
- `filter[scope]` 'internal' | 'internal_and_external'
- `filter[type]` 'comment' | 'proposal'
- `sort_by` 'created_at' | 'updated_at', nullable
- `sort_direction` 'asc' | 'desc', nullable

## Response `200`

Array of `CommentResource`

- object
  - `data` CommentResource[], required
    - `uuid` string, required
    - `party_uuid` string, nullable, required — UUID of the [party](/#parties) the author belongs to
    - `reply_to_comment_uuid` string, nullable, required — UUID of the comment that this comment is replying to, if any
    - `type` 'comment' | 'proposal', required
    - `scope` 'internal' | 'internal_and_external', required
    - `proposal_status` 'open' | 'accepted' | 'rejected', required
    - `is_resolved` boolean, required — True if the comment has been marked as resolved
    - `html_content` string, required — The comment itself. May be empty (e.g. a proposal may be made without an accompanying comment)
    - `author_name` string, nullable, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, nullable, required

## Other responses

- `401` — Unauthenticated
- `403` — Authorization error
- `404` — Not found
- `422` — Validation error

---

[API](https://skmtc.dev/fynk/apis/fynk-api-reference.md) · [All operations](https://skmtc.dev/fynk/apis/fynk-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/fynk/fynk-api-reference/revisions/9657a6757f59/schema)