---
title: "Get Comment List"
method: GET
path: "/comments"
tags: ["Comment"]
---

# Get Comment List

`GET /comments`

Get a list of comments by some conditions

## Query parameters

- `email` string
- `flat_mode` boolean
- `limit` integer
- `name` string
- `offset` integer
- `page_key` string, required
- `scope` 'page' | 'user' | 'site'
- `search` string
- `site_name` string
- `sort_by` 'date_asc' | 'date_desc' | 'vote'
- `type` 'all' | 'mentions' | 'mine' | 'pending'
- `view_only_admin` boolean

## Response `200`

OK

- HandlerResponseCommentList
  - `comments` EntityCookedComment[], required
    - `badge_color` string, required
    - `badge_name` string, required
    - `content` string, required
    - `content_marked` string, required
    - `date` string, required
    - `email_encrypted` string, required
    - `id` integer, required
    - `ip_region` string
    - `is_allow_reply` boolean, required
    - `is_collapsed` boolean, required
    - `is_pending` boolean, required
    - `is_pinned` boolean, required
    - `is_verified` boolean, required
    - `link` string, required
    - `nick` string, required
    - `page_key` string, required
    - `page_url` string, required
    - `rid` integer, required
    - `site_name` string, required
    - `ua` string, required
    - `user_id` integer, required
    - `visible` boolean, required
    - `vote_down` integer, required
    - `vote_up` integer, required
  - `count` integer, required
  - `page` EntityCookedPage
    - `admin_only` boolean, required
    - `date` string, required
    - `id` integer, required
    - `key` string, required
    - `pv` integer, required
    - `site_name` string, required
    - `title` string, required
    - `url` string, required
    - `vote_down` integer, required
    - `vote_up` integer, required
  - `roots_count` integer, required

## Other responses

- `500` — Internal Server Error

---

[API](https://skmtc.net/artalkjs/apis/artalk-api.md) · [All operations](https://skmtc.net/artalkjs/apis/artalk-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/artalkjs/artalk-api/revisions/2f927b464019/schema)