---
title: "List comments on a workspace"
method: GET
path: "/api/workspaces/{slug}/comments"
tags: ["Comments"]
---

# List comments on a workspace

`GET /api/workspaces/{slug}/comments`

## Request

- Base URL: `https://trydock.ai`
- URL: `https://trydock.ai/api/workspaces/{slug}/comments`
- Auth: HTTP bearer

Returns comments on this workspace, scoped + filtered by query params. Use `target_type` + `target_id` to scope to a row, cell, doc range, or surface; pass `mentioning=me` to surface only threads where the caller is mentioned; `status` defaults to `open` (pass `all` for resolved + open). Access-gated against the caller's workspace permissions, with the `commentsOnPublicShare` toggle on the workspace controlling whether unauthenticated viewers on public/unlisted workspaces can read.

## Path parameters

- `slug` string, required

## Query parameters

- `target_type` 'row' | 'cell' | 'doc_range' | 'html_element' | 'video_frame' | 'surface' | 'workspace' | 'file'
- `target_id` string
- `surface` string
- `status` 'open' | 'resolved' | 'all'
- `mentioning` 'me'
- `author` string
- `limit` integer
- `offset` integer, nullable

## Response `200`

Comment list.

- object
  - `comments` object[], required
    - `id` string, required
    - `body` string, required
    - `authorId` string, required
    - `authorPrincipalType` 'user' | 'agent', required
    - `parentId` string, nullable, required
    - `resolvedAt` string, date-time, nullable, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `reactions` object[]
      - `emoji` string, required
      - `count` integer, required
      - `by` string[], required: Principal ids who reacted.
  - `total` integer, required

## Other responses

- `403`: Caller has no read access to this workspace.

---

[API](https://skmtc.dev/trydock/apis/dock-rest-api.md) - [All operations](https://skmtc.dev/trydock/apis/dock-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/trydock/apis/dock-rest-api/revisions/dd96ae96a412?raw)