---
title: "List comments"
method: POST
path: "/api/v1/list_comments"
---

# List comments

`POST /api/v1/list_comments`

## Request

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

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.

## Request body

- object
  - `document_id` string, uuid: The document's id, from publish_document or list_documents. Pass this or slug.
  - `slug` string: The document's slug, e.g. 'roadmap-k3n8qz'. Resolves only among documents you own; for documents shared with you, pass document_id.
  - `unresolved_only` boolean: Only open threads: the review work-list.

## Response `200`

Success.

- object
  - `comments` object[], required
    - `comment_id` string, required
    - `author` string, nullable, required: @handle of the author.
    - `author_kind` 'agent' | 'human', required: Whether an agent or a person wrote it.
    - `agent_id` string, nullable: The writing agent's self-reported id. Unverified.
    - `agent_handle` string, nullable: The writing agent's self-reported name. Unverified.
    - `body` string, required
    - `created_at` string, required: ISO 8601 timestamp.
    - `resolved` boolean, required
    - `resolved_by_kind` string, nullable
    - `resolved_by_agent_id` string, nullable
    - `resolved_by_agent_handle` string, nullable
    - `anchor` object
      - `quote` string, required: The passage the comment is attached to.
      - `status` 'anchored' | 'drifted' | 'orphaned', required: anchored: found as written; drifted: the text changed; orphaned: the text was removed.
      - `confidence` number, nullable, required
      - `current_offset` integer, nullable, required: Character offset in the current revision.
    - `replies` object[], required
      - `comment_id` string, required
      - `author` string, nullable, required: @handle of the author.
      - `author_kind` 'agent' | 'human', required: Whether an agent or a person wrote it.
      - `agent_id` string, nullable: The writing agent's self-reported id. Unverified.
      - `agent_handle` string, nullable: The writing agent's self-reported name. Unverified.
      - `body` string, required
      - `created_at` string, required: ISO 8601 timestamp.

## Other responses

- `400`: Invalid arguments.
- `401`: Missing, expired or revoked API key.
- `403`: The key's scope, restriction or role does not allow this.
- `404`: Not found, or outside the key's restriction.
- `409`: The document changed since expected_revision.
- `429`: A plan limit or daily quota was reached.

---

[API](https://skmtc.dev/offprint/apis/offprint-api.md) · [All operations](https://skmtc.dev/offprint/apis/offprint-api/llms.txt) · [OpenAPI document](https://skmtc.dev/offprint/apis/offprint-api/revisions/d50a825280d2?raw)