---
title: "List comments on a post"
method: GET
path: "/posts/{postId}/comments"
---

# List comments on a post

`GET /posts/{postId}/comments`

## Request

- Base URL: `https://app.voteship.app/api/v1`
- URL: `https://app.voteship.app/api/v1/posts/{postId}/comments`
- Auth: HTTP bearer

List comments for a post. By default returns only public comments. Use the `internal` query parameter to include internal notes.

## Path parameters

- `postId` string, required

## Query parameters

- `internal` 'true' | 'all'

## Response `200`

List of comments

- object
  - `data` Comment[]
    - `id` string
    - `postId` string
    - `body` string
    - `authorName` string, nullable
    - `isInternalNote` boolean
    - `createdAt` string, date-time

---

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