---
title: "List comments"
method: GET
path: "/api/v1/comments"
tags: ["Comments"]
---

# List comments

`GET /api/v1/comments`

## Request

- Base URL: `https://api-docs.busabase.com`
- URL: `https://api-docs.busabase.com/api/v1/comments`
- Auth: none declared

## Query parameters

- `subjectType` 'record' | 'change_request' | 'operation' | 'commit', required: What the comment thread hangs off, which decides how `subjectId` is interpreted.
- `subjectId` string, required: The subject's id, interpreted according to `subjectType`.

## Response `200`

Comments attached to a Busabase subject.

- object[]
  - `id` string, required
  - `subjectType` 'record' | 'change_request' | 'operation' | 'commit', required
  - `subjectId` string, required
  - `recordId` string, required
  - `changeRequestId` string, required
  - `operationId` string, required
  - `commitId` string, required
  - `authorId` string, required
  - `author` object
    - `id` string, required
    - `name` string, required
    - `email` string, required
    - `image` string, required
    - `role` string
  - `body` string, required
  - `mentions` object[]
    - `id` string, required
    - `type` 'member' | 'agent', required
    - `targetId` string, required
    - `label` string, required
    - `start` integer, required
    - `end` integer, required
    - `dispatchStatus` 'not_applicable' | 'queued' | 'linked' | 'failed', required
    - `sessionId` string, required
    - `error` string, required
  - `createdAt` string, required
  - `updatedAt` string, required

---

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