Zum Hauptinhalt springen
Document Operations

List comments

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

GET
/documents/{document}/comments

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

Autorisierungen

Authorizationstringheadererforderlich

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

Pfadparameter

documentstringerforderlich

The document UUID

Query-Parameter

filter[resolution_status]enum<string>query
Verfügbare Optionen: open, resolved
filter[scope]enum<string>query
Verfügbare Optionen: internal, internal_and_external
filter[type]enum<string>query
Verfügbare Optionen: comment, proposal
sort_byenum<string> | nullquery

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

Verfügbare Optionen: created_at, updated_at
sort_directionenum<string> | nullquery

Default is desc

Verfügbare Optionen: asc, desc

Antwort

application/json

Array of CommentResource

dataobject[]erforderlich

Brauchen Sie noch Hilfe? Team fragen