Skip to main content
GET
Get a comment

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

community_interaction_id
integer
required

The ID of the comment

Required range: x >= 0

Response

OK

is_hidden
boolean
required

If the comment is hidden.

is_liked
boolean
required

If the comment is liked.

is_owned
boolean
required

If the brand posted this comment.

text
string
required

The comment body.

tiktok_parent_comment_id
string
required

The parent comment ID provided by TikTok.

assignee_id
integer
read-only

The ID of the user to whom the interaction is assigned.

author_profile_picture_url
string

The url of the author's profile picture.

author_username
string | null
read-only

The handle of the author.

brand_id
integer
read-only

The community interaction's brand ID.

brand_user_reply
object | null

Brand user that created the reply.

comment_count
integer

The total number of root-level comments on the TikTok post.

created_at
string<date-time>
read-only

When the community interaction was created.

id
integer
read-only

The community interaction's ID.

is_archived
boolean
read-only

Whether the community interaction is marked as archived.

is_author_blocked
boolean
read-only

Whether the user is blocked.

is_follow_up
boolean
read-only

Whether the community interaction is marked as follow-up.

is_read
boolean
read-only

Whether the community interaction is marked as read.

media_comment_sentiment
object

The overall sentiment of the post's comments.

media_id
integer
read-only

The ID of the media the comment was made on.

media_type
enum<string>
read-only

The media type of the post.

Available options:
CAROUSEL_ALBUM,
IMAGE,
REELS,
SHORTS,
VIDEO
post_media
object | null

Info about the media the comment was made on.

post_thumbnail_url
string
read-only

The image thumbnail url of the original post.

replies
object[]
read-only

A list of replies to the this comment.

search_result_snippet
string
read-only

Indicates how many messages match the query.

sentiment
object

The comment sentiment.

source_updated_at
string<date-time>
read-only

When the comment was created.

tag_ids
integer[]

List of tag IDs associated with the community interaction.

tickets
object[]
read-only

The tickets created for this community interaction.

tiktok_comment_id
string
read-only

The comment ID provided by TikTok.

tiktok_username
string
read-only

The username of the comment author.

tiktok_video_created_at
string<date-time>
read-only

The post creation timestamp provided by TikTok.

type
enum<string>
read-only

The community interaction type.

Available options:
COMMUNITY_INTERACTION,
FACEBOOK_COMMENT,
FACEBOOK_CONVERSATION,
INSTAGRAM_COMMENT,
INSTAGRAM_CONVERSATION,
TIKTOK_COMMENT,
TWITTER_CONVERSATION,
TWITTER_MENTION,
TWITTER_QUOTE,
TWITTER_RETWEET,
YOUTUBE_COMMENT
updated_at
string<date-time>
read-only

When the community interaction was last updated.

video_pinned_comment_id
integer
read-only

The ID of the pinned comment for the TikTok post associated with the given TikTok comment.