Document apiReferenceComments

comments.list

List all comment threads in the document.

read-onlyidempotent
doc.comments.list(…)

Expected result

Returns a CommentsListResult with an array of comment threads and total count.

Inputs

includeResolvedboolean

When true, includes resolved comments in results. Default: false.

limitinteger

Maximum number of comments to return.

offsetinteger

Number of comments to skip for pagination.

Result

Output fields
evaluatedRevisionstringrequired
totalintegerrequired
itemsobject[]required
pagePageInforequired
Fields
limitintegerrequired
offsetintegerrequired
returnedintegerrequired

Failures

Pre-apply throws

  • INVALID_INPUT

Raw schemas

Open the generated JSON artifact for the exact input, output, success, and failure schemas represented by this contract version.

View raw JSON schemas