Comments

List Comments

Lists comments on every destination of a post, or on one platform-native post.

GET
/v1/comments

Authorization

headerx-api-key<token>

Workspace API key, sent in the x-api-key header. Keys start with op_ and are created in the dashboard.

Query Parameters

post?string

Onepostly post id or platform-native post id. Native ids also need accountId. You can omit it when you pass destinationId.

Length1 <= length
accountId?string

Connection id. Required with a platform-native post id, and picks the destination when a Onepostly post has several.

Length1 <= length
destinationId?string

Destination id. It identifies one destination on its own, so post and accountId become optional.

Length1 <= length
limit?integer
Range1 <= value <= 50
cursor?string

Cursor from the previous response. Works only when the request points to a single destination.

Response Body

Comments

application/json
  1. response
comments*
Example Request
import { Configuration, CommentsApi } from "@onepostly/sdk";const commentsApi = new CommentsApi(  new Configuration({ apiKey: process.env.ONEPOSTLY_API_KEY }));const response = await commentsApi.listComments({  post: "1699f415-7fb6-43f4-9d2a-c447491f32a8",  limit: 25,});console.log(response);
Example Response
{  "comments": {    "post": "b3e1a7c2-8f4d-4e6a-9c1b-2d3e4f5a6b7c",    "subjects": [      {        "scope": "destination",        "subjectId": "d4e5f6a7-8b9c-4d0e-8f1a-2b3c4d5e6f7a",        "accountId": "a1b2c3d4-e5f6-4a7b-8c9d-e0f1a2b3c4d5",        "platform": "instagram",        "externalPostId": "17895695668004550",        "status": "ready",        "comments": [          {            "id": "c1",            "text": "Love this!",            "username": "jane_doe",            "likeCount": 12,            "timestamp": "2026-08-25T10:05:00.000Z",            "parentId": null          }        ],        "nextCursor": null,        "error": null      }    ]  }}