Skip to main content
Version: 2021-07-28

List comments for a post or thread

POST 

/social-media-posting/comments/:platform/list

Paginated list of comments scoped to a post (parentId = postId) or a comment thread (parentId = commentId). Use skip/limit for pagination, sortBy for ordering, originIds to filter by connected account, and search for keyword search.

Request

Version stringrequired

API Version

Available options2021-07-28
platform stringrequired

Supported Comments Platforms

Available optionsfacebookinstagramlinkedincommunitytiktokblueskyyoutubethreads
locationId stringrequired

Location ID

application/json

Bodyrequired

    fromDatestring

    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.

    toDatestring

    End of the published-date window (ISO 8601). If provided, fromDate is also required.

    originIdsstring[]required

    Origin IDs of connected accounts to filter by

    sortBystring

    Sort by top comments or latest comments

    Available optionstoplatest
    searchstring

    Search

    skipnumber

    Pagination offset — number of comments to skip (zero-based). Must be ≥ 0.

    Possible values: >= 0

    Default value: 0
    limitnumber

    Pagination page size — number of comments to return. Must be between 1 and 100.

    Possible values: >= 1 and <= 100

    Default value: 10
    parentIdstring

    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.

application/json

Successful response

Schema
    successbooleanrequired

    Success or Failure

    statusCodenumberrequired

    Status Code

    messagestringrequired

    Message

    resultsobjectrequired

    Comments and pagination metadata