Document Operations

List comments

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

GET

/documents/{document}/comments

List comments

curl --request GET \
  --url 'https://app.fynk.com/v1/api/documents/{document}/comments?filter%5Bresolution_status%5D=open&filter%5Bscope%5D=internal&filter%5Btype%5D=comment&sort_by=created_at&sort_direction=asc' \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "author_name": "Emily Miller",
      "created_at": "2023-11-07T05:31:56Z",
      "html_content": "<p>Hello, world</p>",
      "is_resolved": true,
      "party_uuid": "595703a2-b7f6-4772-a4b7-ab2f9fac3a9f",
      "proposal_status": "open",
      "reply_to_comment_uuid": "488dfa4a-b154-45df-877f-994e76738345",
      "scope": "internal",
      "type": "comment",
      "updated_at": "2023-11-07T05:31:56Z",
      "uuid": "ebf7f37f-be91-4d71-a204-a73928d70c89"
    }
  ]
}

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

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

documentstringrequired

The document UUID

Query Parameters

filter[resolution_status]enum<string>query

Available options: open, resolved

filter[scope]enum<string>query

Available options: internal, internal_and_external

filter[type]enum<string>query

Available options: comment, proposal

sort_byenum<string> | nullquery

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

Available options: created_at, updated_at

sort_directionenum<string> | nullquery

Default is desc

Available options: asc, desc

Response

Array of CommentResource

dataobject[]required

Show child attributes

Still need help? Share an idea