Comments

Get comments

Retrieve a list of comments with optional filters and nested replies.

get/comments

Request

  • Base URL: https://api.presscart.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.presscart.com/comments
  • Auth: HTTP bearer

Query parameters

limitnumber nullable
pagenumber nullable
order_by'asc' | 'desc'
sort_bystring
include_archived'true' | 'false'
skip_pagination'true' | 'false'
entity_typestring
entity_idstring uuid
is_internal'true' | 'false'
user_idstring uuid
parent_comment_idstring
searchstring
team_idstring uuid
include_replies'true' | 'false'

Response

Comments retrieved successfully

total_pagesnumber required
current_pagenumber required
next_pagenumber nullable required
previous_pagenumber nullable required
total_recordsnumber required

Example response

{
  "records": [
    {
      "id": "a7B9c2D4e6F8",
      "is_internal": true,
      "entity_type": "article",
      "entity_id": "123e4567-e89b-12d3-a456-426614174000",
      "team_id": "123e4567-e89b-12d3-a456-426614174000",
      "user_id": "123e4567-e89b-12d3-a456-426614174000",
      "replies": [
        {
          "id": "a7B9c2D4e6F8",
          "is_internal": true,
          "entity_type": "article",
          "entity_id": "123e4567-e89b-12d3-a456-426614174000",
          "team_id": "123e4567-e89b-12d3-a456-426614174000",
          "user_id": "123e4567-e89b-12d3-a456-426614174000"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 3 revisions of this API.