Skip to main content
POST
/
v1
/
public
/
topic-comments.list
curl --location --request POST 'https://api.yourapp.com/v1/public/topic-comments.list' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
  "id": "topic-uuid-123",
  "sort": "createdAt",
  "direction": "DESC"
}'
{
  "data": [
    {
      "id": "comment-uuid-1",
      "text": "Great feature idea!",
      "topicId": "topic-uuid-123",
      "creatorId": "sub-uuid-1",
      "parentId": null,
      "source": "widget",
      "createdAt": "2024-01-17T16:30:00Z",
      "subscriber": {
        "id": "sub-uuid-1",
        "name": "John Doe",
        "email": "john@example.com"
      },
      "replies": [
        {
          "id": "comment-uuid-2",
          "text": "I agree!",
          "parentId": "comment-uuid-1",
          "createdAt": "2024-01-17T17:00:00Z",
          "subscriber": {
            "id": "sub-uuid-2",
            "name": "Jane Smith",
            "email": "jane@example.com"
          }
        }
      ]
    }
  ],
  "pagination": {
    "offset": 0,
    "limit": 50
  }
}

Authentication

Authorization: Bearer YOUR_API_KEY

Request Body

id
string
Topic ID (UUID). If not provided, returns comments from all team topics.
sort
string
default:"createdAt"
Field to sort by (createdAt, updatedAt)
direction
string
default:"DESC"
Sort direction (ASC or DESC)

Response

data
array
Array of comment objects with nested replies
pagination
object
Pagination metadata
curl --location --request POST 'https://api.yourapp.com/v1/public/topic-comments.list' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
  "id": "topic-uuid-123",
  "sort": "createdAt",
  "direction": "DESC"
}'
{
  "data": [
    {
      "id": "comment-uuid-1",
      "text": "Great feature idea!",
      "topicId": "topic-uuid-123",
      "creatorId": "sub-uuid-1",
      "parentId": null,
      "source": "widget",
      "createdAt": "2024-01-17T16:30:00Z",
      "subscriber": {
        "id": "sub-uuid-1",
        "name": "John Doe",
        "email": "john@example.com"
      },
      "replies": [
        {
          "id": "comment-uuid-2",
          "text": "I agree!",
          "parentId": "comment-uuid-1",
          "createdAt": "2024-01-17T17:00:00Z",
          "subscriber": {
            "id": "sub-uuid-2",
            "name": "Jane Smith",
            "email": "jane@example.com"
          }
        }
      ]
    }
  ],
  "pagination": {
    "offset": 0,
    "limit": 50
  }
}

Behavior

  • Hierarchical: Returns top-level comments with nested replies
  • Team-Wide: If no topic ID provided, returns comments from all team topics
  • Includes Topic: When listing all comments, includes topic details for context

Use Cases

  • Topic Discussion: Display all comments on a topic
  • Zapier Integration: Fetch all new topic comments across roadmap
  • Activity Feed: Show recent topic activity

Notes

  • Without topic ID, fetches from all team topics (useful for Zapier)
  • Returns empty array if topic has no comments
  • Deleted subscribers still shown in comment history