---
title: "The comment threads across the document, in tab and outline order, with each element's ref and label. status=open (default), resolved or all."
method: GET
path: "/documents/{id}/comments"
tags: ["Documents"]
---

# The comment threads across the document, in tab and outline order, with each element's ref and label. status=open (default), resolved or all.

`GET /documents/{id}/comments`

## Request

- Base URL: `https://www.livediagram.app/api`
- URL: `https://www.livediagram.app/api/documents/{id}/comments`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-Owner-Id`

## Path parameters

- `id` string, required

## Query parameters

- `status` string

## Response `200`

Success.

- object
  - `threads` DocumentCommentThread[], required
    - `cell` string
    - `cellRef` string
    - `comments` object[], required
      - `authorColor` string, required
      - `authorId` string
      - `authorName` string, required
      - `createdAt` number, required
      - `id` string, required
      - `mentions` CommentMention[]
        - `handle` string, required
        - `memberId` string
        - `name` string, required
        - `userId` string, nullable, required
      - `text` string, required
      - `tokenId` string
    - `elementId` string, required
    - `label` string, nullable, required
    - `ref` string, required
    - `resolved` boolean, required
    - `tabId` string, required
    - `tabName` string, required

## Other responses

- `400`: Error.
- `401`: Error.
- `403`: Error.
- `404`: Error.
- `405`: Error.
- `410`: Error.
- `429`: Rate limited. Back off and retry.

---

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