Skip to main content
Comments

List comments

Returns comments for your organization.

GET
/v2/comments

Comments are threaded discussions. Each comment can have:

  • Author information
  • Voting (upvotes/downvotes)
  • Privacy settings (public/private)
  • Moderation status
  • Parent comment reference for threading

Filtering

Optionally filter by:

  • postId - Get comments for a specific post
  • changelogId - Get comments for a specific changelog

If no filter is provided, returns all comments across the organization.

Pagination

This endpoint uses cursor-based pagination:

  • limit - Number of comments to return (1-100, default 10)
  • cursor - Opaque cursor from a previous response's nextCursor field

Example: To paginate through results:

  1. First request: GET /v2/comments?postId={id}&limit=10
  2. If nextCursor is not null, use it for the next page
  3. Next request: GET /v2/comments?postId={id}&limit=10&cursor={nextCursor}

Response Format

Returns a list object with:

  • object - Always "list"
  • data - Array of comment objects (flat structure with parentCommentId for threading)
  • nextCursor - Cursor for the next page (null if no more results)

Comment Structure

Each comment includes:

  • id - Unique comment identifier
  • postId / changelogId - Reference to the parent content
  • parentCommentId - Reference to parent comment (null for root comments)
  • content - Comment content in HTML format
  • author - Author information (id, name, profilePicture, type)
  • upvotes / downvotes / score - Voting metrics
  • isPrivate - Whether comment is only visible to admins
  • inReview - Whether comment is pending moderation
  • created / updated - Unix timestamps

Additional Filters

  • privacy - Filter by privacy: "public", "private", or "all"
  • inReview - Filter by moderation status (true/false)

Sorting

Use sortBy to sort results:

  • best - Sort by confidence score (default, like Reddit)
  • top - Sort by net score (upvotes - downvotes)
  • new - Sort by creation date, newest first
  • old - Sort by creation date, oldest first
Authorizationstringheaderrequired

API key as Bearer token. Use: Authorization: Bearer sk_...

postIdstringquery

Filter comments by post ID

Example: 507f1f77bcf86cd799439011
changelogIdstringquery

Filter comments by changelog ID

Example: 507f1f77bcf86cd799439012
privacyenum<string>query

Filter comments by privacy

Available options: public, private, all
Example: public
inReviewboolean | nullquery

Filter by review status

Example: false
limitintegerquerydefault:10

Maximum number of comments to return

Required range: 1 <= x <= 100
Example: 10
cursorstringquery

Cursor for pagination. Use nextCursor from previous response.

Maximum string length: 512
Example: eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9
sortByenum<string>querydefault:best

Sort order for comments

Available options: best, top, new, old
Example: best
Featurebase-Versionenum<string>header

API version for this request. Defaults to your organization's configured API version if not specified.

Available options: 2026-08-19.orbit, 2026-01-01.nova, 2025-12-12.clover
Example: 2026-08-19.orbit

Response

application/json

Success

dataobject[]required

Array of comments

nextCursorstring | nullrequired

Cursor for fetching the next page (cursor-based pagination)

Maximum string length: 512
Example: eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9
objectenum<string>required

Object type identifier

Available options: list
Example: list
paginationobject

Pagination metadata for page-based requests