v1

latestOpenAPI 3.1.02026-08-066378446.6 KB

Document Operations

List comments

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

Lists the comments that have been made on a document.

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 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

get/documents/{document}/comments

Path parameters

documentstring required

The document UUID

Query parameters

filter[resolution_status]'open' | 'resolved'

filter[scope]'internal' | 'internal_and_external'

filter[type]'comment' | 'proposal'

sort_by'created_at' | 'updated_at' nullable

Name of the field to sort the response by. The default is updated_at.

sort_direction'asc' | 'desc' nullable

Default is desc

Response

Array of CommentResource

Example response

{
  "data": [
    {
      "uuid": "ebf7f37f-be91-4d71-a204-a73928d70c89",
      "party_uuid": "595703a2-b7f6-4772-a4b7-ab2f9fac3a9f",
      "reply_to_comment_uuid": "488dfa4a-b154-45df-877f-994e76738345",
      "html_content": "<p>Hello, world</p>",
      "author_name": "Emily Miller"
    }
  ]
}