Unipile: List Post Comments

List the comments on a post, or the replies to one comment.

Tool ID: unipile_list_post_comments

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'unipile_list_post_comments',
  {
    "account_id": "123456789",
    "post_id": "post_123"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute unipile_list_post_comments --input '{
  "account_id": "123456789",
  "post_id": "post_123"
}' --json

Example response

The static output schema lacks the details for a reliable example. Use deepline describe unipile_list_post_comments --json for the complete live contract.

Input reference

Returns a list of either comments on a given post or replies on a given comment.

Name	Type	Required	Default	Details
`payload.cursor`	`string`	No	—	A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved. Minimum length: 1.
`payload.limit`	`integer`	No	—	A limit for the number of items returned in the response. The value can be set between 1 and 100. Minimum: 1. Maximum: 100.
`payload.sort_by`	`"MOST_RECENT" \| "MOST_RELEVANT"`	No	—	The sort method for the post comments. Default is MOST_RECENT. Allowed: `MOST_RECENT`, `MOST_RELEVANT`.
`payload.comment_id`	`string`	No	—	The id of the comment to get replies from. `Linkedin`: use the comment `id` returned by the comments list.
`payload.account_id`	`string`	Yes	—	The id of the account to perform the request from.
`payload.post_id`	`string`	Yes	—	The ID of the associated post. `Linkedin`: use the `social_id` from the post object (GET post or list posts). The post id visible in url will not work in all case, you can refer here for more details : https://developer.unipile.com/docs/posts-and-comments `Instagram`: Need to use the provider_id. Short code cannot be used here (www.instagram.com/p/SHORTCODE)

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Provider response payload.
`result.data.object`	`"CommentList"`	Yes	—	Allowed: `CommentList`.
`result.data.items`	`array`	Yes	—	—
`result.data.items[].object`	`"Comment"`	Yes	—	—
`result.data.items[].id`	`string`	Yes	—	A unique identifier.
`result.data.items[].post_id`	`string`	Yes	—	A unique identifier.
`result.data.items[].post_urn`	`string`	Yes	—	A unique identifier.
`result.data.items[].thread_id`	`string`	No	—	—
`result.data.items[].author`	`string \| null`	Yes	—	—
`result.data.items[].author_details`	`object`	Yes	—	—
`result.data.items[].author_details.id`	`string \| null`	Yes	—	—
`result.data.items[].author_details.headline`	`string \| null`	Yes	—	—
`result.data.items[].author_details.profile_url`	`string \| null`	Yes	—	—
`result.data.items[].author_details.profile_picture_url`	`string \| null`	Yes	—	—
`result.data.items[].author_details.network_distance`	`"FIRST_DEGREE" \| "SECOND_DEGREE" \| "THIRD_DEGREE" \| "OUT_OF_NETWORK" \| null`	Yes	—	—
`result.data.items[].date`	`string`	Yes	—	—
`result.data.items[].text`	`string`	Yes	—	—
`result.data.items[].picture_url`	`string`	No	—	—
`result.data.items[].reaction_counter`	`number`	Yes	—	—
`result.data.items[].reply_counter`	`number`	Yes	—	—
`result.data.items[].impressions_counter`	`number`	No	—	—
`result.data.items[].user_reacted`	`"LIKE" \| "PRAISE" \| "APPRECIATION" \| "EMPATHY" \| "INTEREST" \| "ENTERTAINMENT"`	No	—	—
`result.data.items[].provider_id`	`string`	Yes	—	—
`result.data.items[].author.provider_id`	`string`	Yes	—	—
`result.data.items[].author.messaging_id`	`string`	Yes	—	—
`result.data.items[].author.public_identifier`	`string`	Yes	—	—
`result.data.items[].author.pk`	`string`	Yes	—	—
`result.data.items[].author.profile_pic_url`	`string`	Yes	—	—
`result.data.items[].author.is_verified`	`boolean`	Yes	—	—
`result.data.items[].created_at`	`number`	Yes	—	—
`result.data.items[].is_covered`	`boolean`	Yes	—	—
`result.data.items[].child_comment_count`	`number`	Yes	—	—
`result.data.items[].restricted_status`	`string \| null`	Yes	—	—
`result.data.items[].has_liked_comment`	`boolean`	Yes	—	—
`result.data.items[].giphy_media_info`	`string \| null`	Yes	—	—
`result.data.items[].parent_comment_id`	`string \| null`	Yes	—	—
`result.data.items[].comment_like_count`	`number`	Yes	—	—
`result.data.cursor`	`string \| null`	Yes	—	—
`result.data.total_items`	`number \| null`	Yes	—	—
`result.data.paging`	`object`	Yes	—	—
`result.data.paging.start`	`number \| null`	Yes	—	—
`result.data.paging.page_count`	`number`	Yes	—	—
`result.data.paging.total_count`	`number \| null`	Yes	—	—
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation