List all comments

Understanding how to use FeatureOS API to build custom integrations.

Introduction

This endpoint lists all comments of the specific post by default.

GET https://api.featureos.app/api/v3/comments

curl -X GET 'https://api.featureos.app/api/v3/comments' \
  -H 'API-KEY: YOUR_API_KEY' \
  -H 'Content-Type: application/json'

const response = await fetch('https://api.featureos.app/api/v3/comments', {
  method: 'GET',
  headers: {
    'API-KEY': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
});
const data = await response.json();

import requests

response = requests.get(
    'https://api.featureos.app/api/v3/comments',
    headers={
        'API-KEY': 'YOUR_API_KEY',
        'Content-Type': 'application/json'
    }
)
data = response.json()

Headers

Parameter	Default	Description
API-KEY	-	Generate from organization settings on the admin dashboard.

Query Parameters

Parameter	Default	Format	Description
page	1	Integer	Used to paginate responses.
feature_request_id	-	Integer	The ID of the post returned in the list posts endpoint.
from_date	-	String (YYYY-MM-DD)	Filter comments based on its created date. Use it along with the below "to_date" parameter to filter the comments for a particular date range.
to_date	-	String (YYYY-MM-DD)	Filter comments based on its created date. Use it along with the above "from_date" parameter to filter the comments for a particular date range.

Sample response

{
  "success": true,
  "comments": [
    {
      "id": 272,
      "comment_html": "<p>Sample Comment 1</p>\n",
      "comment": "Sample Comment 1",
      "parent_id": null,
      "feature_request": {
        "id": 168181,
        "url": "https://feedback.featureos.app/b/feedback/p/hello-world",
        "title": "fafafas"
      },
      "pinned": false,
      "internal": false,
      "approval_status": "approved",
      "created_at": "2023-04-24T09:53:34.000Z",
      "updated_at": "2023-04-24T09:53:34.000Z",
      "author": {
        "id": 1,
        "name": "swathy",
        "email": "[email protected]",
        "profile_picture": {
          "url": null
        },
        "url": "https://feedback.featureos.app/admin/users?userId=1",
        "role": "admin"
      }
    },
    {
      "id": 271,
      "comment_html": "<p>Sample Comment 2</p>\n",
      "comment": "Sample Comment 2",
      "parent_id": null,
      "feature_request": {
        "id": 168181,
        "url": "https://feedback.featureos.app/b/feedback/p/hello-world",
        "title": "fafafas"
      },
      "pinned": false,
      "internal": false,
      "approval_status": "approved",
      "created_at": "2023-04-24T09:53:33.000Z",
      "updated_at": "2023-04-24T09:53:33.000Z",
      "author": {
        "id": 1,
        "name": "swathy",
        "email": "[email protected]",
        "profile_picture": {
          "url": null
        },
        "url": "https://feedback.featureos.app/admin/users?userId=1",
        "role": "admin"
      }
    }
  ]
}