Developers
Comments9

List product comments

GET/products/{product_id}/comments

Lists the top-level comments posted on a product's lessons. Replies are available through the list comment replies operation.

The collection can be filtered by lesson, user, status, and a text search term. Results are paginated with a cursor and sorted by ID, newest first by default; use sort=id for oldest first.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Path Parameters

product_id*string

Public ID of the product, prefixed with prd_.

Query Parameters

limit?integer

Maximum number of items to return, from 1 to 200.

Range1 <= value <= 200
cursor?string

Cursor for the next page, taken from page.next_cursor of the previous response.

sort?string

Sort order. A leading - sorts in descending order.

Value in

  • "id"
  • "-id"
lesson_id?string

Only comments on the lesson with this public ID.

user_id?string

Only comments written by the user with this public ID.

status?string

Only comments with this moderation status.

Value in

  • "pending"
  • "approved"
  • "hidden"
q?string

Text search term.

Header Parameters

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/products/string/comments"
{  "data": [    {      "created_at": "2019-08-24T14:15:22Z",      "id": "string",      "lesson_id": "string",      "object": "comment",      "pinned": true,      "product_id": "string",      "replies_count": 0,      "revision": "string",      "status": "pending",      "text": "string",      "updated_at": "2019-08-24T14:15:22Z",      "user": {        "id": "string",        "name": "string"      }    }  ],  "page": {    "limit": 1,    "next_cursor": "string",    "prev_cursor": "string"  }}

Comments9

Comments in API v3: list product comments, retrieve a comment, update a comment, delete a comment, list comment replies, create a comment reply, update a comment reply, delete a comment reply, list comments for moderation.

Retrieve a comment GET

Retrieves a top-level comment by its public ID. The response includes an `ETag` representing the current revision. Send this value in the `If-Match` header when updating the comment to avoid overwriting a newer version.