HighLevel: List comments for a post or thread

← Social planner operations · Get started

Operation gohighlevel.get_comment_list

Provider route: POST /social-media-posting/comments/{platform}/list. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/gohighlevel with npm, or alter-sdk-gohighlevel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HighLevelIntegration } from "@alter-ai/gohighlevel";

async function execute(input: Parameters<HighLevelIntegration["socialPlanner"]["getCommentList"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HighLevelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.socialPlanner.getCommentList(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_gohighlevel import HighLevelIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HighLevelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.social_planner.get_comment_list(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.platform	string	Required within parent	One of: facebook, instagram, linkedin, community, tiktok, bluesky, youtube, threads
query	object	Required within parent	Additional keys: not allowed
query.locationId	string	Required within parent
body	Model	Required within parent	Expand List comments for a post or thread — request body — body

Referenced models: List comments for a post or thread — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand List comments for a post or thread — response body

Referenced models: List comments for a post or thread — response body

Schemas

2 more schemas are linked from the tables above, on the schema pages.

List comments for a post or thread — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
fromDate	string	Optional	Start of the published-date window (ISO 8601). If provided, `toDate` is also required, and `fromDate` must be ≤ `toDate`. Omit both to disable date filtering.
limit	number	Optional	Pagination page size — number of comments to return. Must be between 1 and 100. Default: 10 Maximum: 100 Minimum: 1
originIds	array	Required within parent	Origin IDs of connected accounts to filter by
originIds[]	string	Each item
parentId	string	Optional	Parent ID — pass the Highlevel post ID (for replies under a specific post) or the Highlevel comment ID (for replies under a specific comment). Omit to list all top-level comments for the location filtered by `originIds`. Must be a valid 24-character Highlevel ID, not the native platform ID.
search	string	Optional	Search
skip	number	Optional	Pagination offset — number of comments to skip (zero-based). Must be ≥ 0. Default: 0 Minimum: 0
sortBy	string	Optional	Sort by top comments or latest comments Default: latest One of: top, latest
toDate	string	Optional	End of the published-date window (ISO 8601). If provided, `fromDate` is also required.

List comments for a post or thread — response body

Field	Type	Presence	Description and constraints
$	object	Root
message	string	Required within parent	Message
results	JSON	Required within parent	Comments and pagination metadata
results (allOf 1)	Model	All variants apply	Expand List comments for a post or thread — response body — results comments, meta
statusCode	JSON	Required within parent
statusCode (anyOf 1)	number	Alternative	Status Code
statusCode (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
success	boolean	Required within parent	Success or Failure

Referenced models: List comments for a post or thread — response body — results comments, meta

List comments for a post or thread — response body — results comments, meta

Field	Type	Presence	Description and constraints
$	object	Root
comments	array	Required within parent	List of comments
comments[]	Model	Each item	Expand Create a comment or reply — response body — results id, attachments, author, content, created At, is Deleted, is Edited, is Parent Thread, is Post, is Read, level, like Count, origin Id, platform, platform Comment Id, platform Parent Id, platform Post Id, post Id, preview Link, published At, quote Count, reaction Count, reply Count, repost Count, share Count, updated At
meta	JSON	Required within parent	Pagination metadata
meta (allOf 1)	Model	All variants apply	Expand List comments for a post or thread — response body — results comments, meta meta has More, limit, skip, total, total Unread

Referenced models: Create a comment or reply — response body — results id, attachments, author, content, created At, is Deleted, is Edited, is Parent Thread, is Post, is Read, level, like Count, origin Id, platform, platform Comment Id, platform Parent Id, platform Post Id, post Id, preview Link, published At, quote Count, reaction Count, reply Count, repost Count, share Count, updated At, List comments for a post or thread — response body — results comments, meta meta has More, limit, skip, total, total Unread

Create a comment or reply — response body — results id, attachments, author, content, created At, is Deleted, is Edited, is Parent Thread, is Post, is Read, level, like Count, origin Id, platform, platform Comment Id, platform Parent Id, platform Post Id, post Id, preview Link, published At, quote Count, reaction Count, reply Count, repost Count, share Count, updated At

Field	Type	Presence	Description and constraints
$	object	Root
_id	string	Required within parent	Highlevel comment ID
attachments	array	Optional	Attachments on the comment
attachments[]	Model	Each item	Expand Create a comment or reply — response body — results id, attachments, author, content, created At, is Deleted, is Edited, is Parent Thread, is Post, is Read, level, like Count, origin Id, platform, platform Comment Id, platform Parent Id, platform Post Id, post Id, preview Link, published At, quote Count, reaction Count, reply Count, repost Count, share Count, updated At attachments item
author	JSON	Optional	Author of the comment. May be partial or missing for some sync paths.
author (allOf 1)	Model	All variants apply	Expand Create a comment or reply — response body — results id, attachments, author, content, created At, is Deleted, is Edited, is Parent Thread, is Post, is Read, level, like Count, origin Id, platform, platform Comment Id, platform Parent Id, platform Post Id, post Id, preview Link, published At, quote Count, reaction Count, reply Count, repost Count, share Count, updated At author id, name, profile Pic
content	string	Optional	Comment content. May be empty or missing for attachment-only comments.
createdAt	string	Optional	Time the comment record was created in Highlevel Format: date-time
isDeleted	boolean	Required within parent	Whether the comment was deleted
isEdited	boolean	Required within parent	Whether the comment was edited
isParentThread	boolean	Optional	True if this comment is a top-level comment on the post; false if it is a reply to another comment
isPost	boolean	Required within parent	True if this record represents the root post (not a comment)
isRead	boolean	Required within parent	Whether the comment has been read
level	JSON	Optional
level (anyOf 1)	number	Alternative	Comment depth (0 = post, 1 = comment, 2 = reply)
level (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
likeCount	JSON	Required within parent
likeCount (anyOf 1)	number	Alternative	Number of likes on the comment
likeCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
originId	string	Required within parent	Connected account / page ID on the native platform
platform	string	Required within parent	Platform the comment was posted on
platformCommentId	string	Optional	Native platform comment ID
platformParentId	string	Optional	Native platform parent ID (the post or comment this is a reply to)
platformPostId	string	Optional	Native platform post ID
postId	string	Required within parent	Highlevel post ID
previewLink	string	Optional	Direct link to view the comment on the native platform
publishedAt	string	Optional	Time the comment was published on the native platform. May be missing for legacy or webhook-synced records. Format: date-time
quoteCount	JSON	Required within parent
quoteCount (anyOf 1)	number	Alternative	Number of quote posts (platform-specific)
quoteCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
reactionCount	JSON	Required within parent
reactionCount (anyOf 1)	number	Alternative	Number of reactions on the comment
reactionCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
replyCount	JSON	Required within parent
replyCount (anyOf 1)	number	Alternative	Number of replies to the comment
replyCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
repostCount	JSON	Required within parent
repostCount (anyOf 1)	number	Alternative	Number of reposts of the comment (platform-specific)
repostCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
shareCount	JSON	Required within parent
shareCount (anyOf 1)	number	Alternative	Number of shares of the comment
shareCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
updatedAt	string	Optional	Time the comment record was last updated in Highlevel Format: date-time

Referenced models: Create a comment or reply — response body — results id, attachments, author, content, created At, is Deleted, is Edited, is Parent Thread, is Post, is Read, level, like Count, origin Id, platform, platform Comment Id, platform Parent Id, platform Post Id, post Id, preview Link, published At, quote Count, reaction Count, reply Count, repost Count, share Count, updated At attachments item, Create a comment or reply — response body — results id, attachments, author, content, created At, is Deleted, is Edited, is Parent Thread, is Post, is Read, level, like Count, origin Id, platform, platform Comment Id, platform Parent Id, platform Post Id, post Id, preview Link, published At, quote Count, reaction Count, reply Count, repost Count, share Count, updated At author id, name, profile Pic

Create a comment or reply — response body — results id, attachments, author, content, created At, is Deleted, is Edited, is Parent Thread, is Post, is Read, level, like Count, origin Id, platform, platform Comment Id, platform Parent Id, platform Post Id, post Id, preview Link, published At, quote Count, reaction Count, reply Count, repost Count, share Count, updated At attachments item

Field	Type	Presence	Description and constraints
$	object	Root
thumbnail	string	Optional	Thumbnail URL
type	string	Optional	Attachment MIME type or platform-specific type
url	string	Optional	Attachment URL
videoUrl	string	Optional	Video URL (when attachment is a video)

Policy, approvals and errors

SDK function policy ID: gohighlevel.get_comment_list. Catalog operation: get-comment-list. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"Version": "v3"}

Official provider source