Post comments API

Get list of comments of a specific post

auth headers of author are requried if post is private note or posted in private room.

Path Parameters

post_id integer required

post id

Query Parameters

client_auth_token string required

Client API token

Header Parameters

access-token string

user access token

client string

client access token

expiry string
timestamp of token expiry
Example: 1531315250
token-type string
access token type
Example: Bearer
uid string
user uid
Example: user@quranreflect.com

Responses

• 200
• 404

---

List of comments and replies

application/json

Schema

Example (from schema)

---

Schema

success boolean
data object
comments object[]
Array [
id integer
body string
is_private boolean
hidden boolean
created_at string
comment_policy_show boolean
parent_id nullable
parent comment id if this is a reply to another comment
children undefined[]
Comment replies
author object
id integer
username string
name string
first_name string
last_name string
verified boolean
profile_img string
followed boolean
original_profile_img string
rooms_list object[]
display_name string
user_type nullable
]

{
  "success": true,
  "data": {
    "comments": [
      {
        "id": 0,
        "body": "string",
        "is_private": true,
        "hidden": true,
        "created_at": "string",
        "comment_policy_show": true,
        "children": [
          null
        ],
        "author": {
          "id": 0,
          "username": "string",
          "name": "string",
          "first_name": "string",
          "last_name": "string",
          "verified": true,
          "profile_img": "string",
          "followed": true,
          "original_profile_img": "string",
          "rooms_list": [
            {}
          ],
          "display_name": "string"
        }
      }
    ]
  }
}

Not Found

application/json

Schema

Example (from schema)

Post not found

---

Schema

status integer
success boolean
error string

{
  "status": 0,
  "success": true,
  "error": "string"
}

{
  "status": 404,
  "success": false,
  "error": "Couldn't find Post with 'id'=4"
}

Loading...