Developers
Comments9

List comments for moderation

GET/support/comments

Lists top-level comments across all products accessible with the current credentials, for use as a moderation queue.

When status is omitted, only comments with the pending status are returned. 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

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"
status?string

Only comments with this moderation status.

Value in

  • "pending"
  • "approved"
  • "hidden"

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

curl -X GET "https://example.com/support/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"  }}

Delete a comment reply DELETE

Deletes a single reply from a comment. The top-level comment and its other replies are not affected. Only replies written by an administrator or an API credential (`author.kind` is `admin` or `credential`) can be deleted. Attempts to delete any other reply return `403` with the `permission_denied` error code and `details[].field` set to `author.kind`. To remove the entire conversation, delete the top-level comment instead.

Webhooks13

Next Page