List comments

List a document's comment threads. Each thread carries its anchor: the quoted passage, its status after subsequent edits (anchored | drifted — the text changed | orphaned — the text was removed), and where it sits in the current revision. Use unresolved_only to get the review work-list; after revising the document to address a comment, call resolve_comment.

post/api/v1/list_comments

Request

  • Base URL: https://offprint.io
  • URL: https://offprint.io/api/v1/list_comments
  • Auth: HTTP bearer

Request body

document_idstring uuid

The document's id, from publish_document or list_documents. Pass this or slug.

slugstring

The document's slug, e.g. 'roadmap-k3n8qz'. Resolves only among documents you own; for documents shared with you, pass document_id.

unresolved_onlyboolean

Only open threads: the review work-list.

Response

Success.

Changes

No recorded changes to this operation across all 1 revision of this API.