Skip to main content
POST
/
v1
/
public
/
feedback-comments.list
curl --location --request POST 'https://api.yourapp.com/v1/public/feedback-comments.list' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
  "feedbackId": "feedback-uuid",
  "limit": 20,
  "offset": 0,
  "direction": "ASC"
}'
{
  "data": [
    {
      "id": "comment-uuid-1",
      "text": "Great idea! We really need this feature.",
      "feedbackId": "feedback-uuid",
      "subscriberId": "subscriber-uuid-1",
      "subscriber": {
        "id": "subscriber-uuid-1",
        "name": "John Doe",
        "email": "john@example.com",
        "avatarUrl": "https://example.com/avatar.jpg"
      },
      "isPrivate": false,
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z"
    },
    {
      "id": "comment-uuid-2",
      "text": "We're working on this! Expected in Q2.",
      "feedbackId": "feedback-uuid",
      "subscriberId": "team-member-uuid",
      "subscriber": {
        "id": "team-member-uuid",
        "name": "Support Team",
        "email": "support@company.com",
        "avatarUrl": null
      },
      "isPrivate": false,
      "createdAt": "2024-01-15T14:22:00Z",
      "updatedAt": "2024-01-15T14:22:00Z"
    }
  ],
  "pagination": {
    "total": 12,
    "limit": 20,
    "offset": 0
  }
}

Authentication

Authorization: Bearer YOUR_API_KEY

Request Body

feedbackId
string
required
The feedback ID to get comments for
limit
number
default:"20"
Number of comments to return per page
offset
number
default:"0"
Number of comments to skip for pagination
sort
string
default:"createdAt"
Field to sort by (createdAt, updatedAt)
direction
string
default:"ASC"
Sort direction (ASC for oldest first, DESC for newest first)

Response

data
array
Array of comment objects
pagination
object
Pagination metadata
curl --location --request POST 'https://api.yourapp.com/v1/public/feedback-comments.list' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
  "feedbackId": "feedback-uuid",
  "limit": 20,
  "offset": 0,
  "direction": "ASC"
}'
{
  "data": [
    {
      "id": "comment-uuid-1",
      "text": "Great idea! We really need this feature.",
      "feedbackId": "feedback-uuid",
      "subscriberId": "subscriber-uuid-1",
      "subscriber": {
        "id": "subscriber-uuid-1",
        "name": "John Doe",
        "email": "john@example.com",
        "avatarUrl": "https://example.com/avatar.jpg"
      },
      "isPrivate": false,
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-01-15T10:30:00Z"
    },
    {
      "id": "comment-uuid-2",
      "text": "We're working on this! Expected in Q2.",
      "feedbackId": "feedback-uuid",
      "subscriberId": "team-member-uuid",
      "subscriber": {
        "id": "team-member-uuid",
        "name": "Support Team",
        "email": "support@company.com",
        "avatarUrl": null
      },
      "isPrivate": false,
      "createdAt": "2024-01-15T14:22:00Z",
      "updatedAt": "2024-01-15T14:22:00Z"
    }
  ],
  "pagination": {
    "total": 12,
    "limit": 20,
    "offset": 0
  }
}

Behavior

  • Chronological Order: By default, comments sorted oldest first (ASC)
  • Includes Subscriber: Each comment includes subscriber details
  • Public & Private: Returns both public and private comments
  • Paginated: Use limit/offset for loading more comments

Use Cases

  • Comment Thread: Display discussion on feedback items
  • Activity Feed: Show engagement and responses
  • Moderation: Review all comments on feedback

Notes

  • Private comments only visible to team members
  • Includes subscriber avatar and name for display
  • Supports pagination for long comment threads
  • Default sort is oldest first for conversational flow