Sign in

v1

latestOpenAPI 3.1.02026-07-24318141.2 MB

List comments

get/comments/

Query parameters

comment_board_idstring required

multiple comment_board_ids are accepted.

thread_comment_idstring

Comment thread ID

parent_comment_idstring

This will return all the replies to the parent_comment_id within that board

ordering'created_at' | '-created_at' | 'reaction_count' | '-reaction_count' | 'reply_count' | '-reply_count' | 'trending_score' | 'relationship' | '-relationship'
  1. created_at → default ordering, returns comments in ascending order of created_at 2. -created_at. → opposite of created at, returns comments in descending order of created_at, 3. reaction_count -> order by reaction_count , in desc order 4. -reaction_count -> opposite of reaction_count. 5. reply_count -> order by reply_count of a comments , in desc order 6. -reply_count -> opposite of reply_count 7. trending_score -> Order by trending score, most trending comment first 8. relationship -> at the top comments from author with specified relationship in order_relationship_type 9. -relationship -> opposite of relationship
replied_sincestring

Replies created time greater than or equal

replied_untilstring

Replies created time less than or equal

top_levelboolean

Set to true to return only top level comments

is_replyboolean

If the comment is a reply

is_reportedboolean

Reported Comments

is_deletedboolean

Whether deleted comments should be included. Setting is_deleted=False will exclude all deleted comments whether or not they have non-deleted replies.

without_deleted_threadboolean

Set to true to exclude deleted threads in response

sincestring date

Filters comments created after this time.

untilstring date

Filters comments created until this time.

reaction_idstring

if want to sort comments by reaction_count on a specific reaction_id, this requires ordering as reaction_count, -reaction_count

attributesstring

filters comment by key, value pair eg. ?attributes=key:value

relationship_typestring

Unique keys for profile relationship types (Example - follow, friend)

relationship_from_profile_idstring

Profile UUID for the from_profile in a profile relationship. This parameter or an auth token for the from_profile is required with relationship_type.

mentioned_profile_idstring

Profile Id of mentioned user

trending_score_gtenumber

Trending score greater than or equal to

trending_score_ltenumber

Trending score less than or equal to

is_high_qualityboolean

Filter comments that have been categorized as high quality passing all comment quality rules

per_board_limitnumber

Limit the number of comments for each passed comment board ID by a certain number

ordering_relationship_typestring

Returns a list of comments along with specified relationship between integrator and author at the top or bottom depends of ordering param. If this param is used ordering must have relationship or -relationship value.

Response

200