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

# List comments

`GET /api/v1/comments`

## Request

- Base URL: `https://app.tryadeli.com`
- URL: `https://app.tryadeli.com/api/v1/comments`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/adeli/apis/adeli-api/docs/api/v1/comments/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `platform` 'instagram' | 'facebook' | 'tiktok' | 'youtube', required
- `accountId` string, uuid, required
- `profileId` string, uuid
- `postId` string
- `cursor` string

## Response `200`

Success

- object
  - `platform` 'instagram' | 'facebook' | 'tiktok' | 'youtube', required
  - `accountId` string, uuid, required
  - `profileId` string, uuid, required
  - `postId` string, nullable, required
  - `posts` object[], required
    - `id` string, required
    - `caption` string, nullable, required
    - `thumbnailUrl` string, nullable, required
    - `permalink` string, nullable, required
    - `publishedAt` string, date-time, nullable, required
    - `commentsCount` number, nullable, required
    - `editable` boolean
  - `comments` object[], required
    - `id` string, required
    - `mediaId` string, required
    - `parentId` string, nullable, required
    - `authorName` string, required
    - `authorFullName` string, nullable, required
    - `authorHandle` string, required
    - `avatarUrl` string, nullable, required
    - `profileUrl` string, nullable, required
    - `body` string, required
    - `likeCount` number, required
    - `isCreator` boolean, required
    - `isHidden` boolean, required
    - `createdAt` string, date-time, required
    - `authorId` string, nullable
    - `liked` boolean
    - `replyCount` integer
    - `deletable` boolean
  - `nextCursor` string, nullable, required
  - `complete` boolean, required
  - `syncedAt` string, date-time, nullable, required

## Other responses

- `400`: Invalid request or provider failure
- `401`: Missing or invalid API key
- `403`: The connection lacks a permission or provider-confirmed resource
- `404`: Profile, account, or object not found
- `409`: The request conflicts with existing state
- `422`: The connected account cannot perform this operation
- `429`: Provider quota or rate limit exhausted
- `502`: Invalid request or provider failure
- `503`: The platform is temporarily unavailable

---

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