Video Comments

List threads of a video

GET

https://peertube2.cpy.re/api/v1/videos/{id}/comment-threads

curl -X GET 'https://peertube2.cpy.re/api/v1/videos/42/comment-threads?count=15'

const response = await fetch('https://peertube2.cpy.re/api/v1/videos/42/comment-threads?count=15', {
  method: 'GET',
});

const data = await response.text();

import requests

response = requests.get('https://peertube2.cpy.re/api/v1/videos/42/comment-threads?count=15')
print(response.text)

200

{
  "total": 0,
  "totalNotDeletedComments": 0,
  "data": [
    {
      "id": 42,
      "url": "https://example.com",
      "text": "This video is wonderful!",
      "threadId": 42,
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "deletedAt": null,
      "isDeleted": false,
      "heldForReview": true,
      "totalRepliesFromVideoAuthor": 0,
      "totalReplies": 0,
      "account": {
        "id": 42,
        "url": "https://example.com",
        "avatars": [
          {
            "path": "string",
            "fileUrl": "string",
            "width": 0,
            "height": 0,
            "createdAt": "2024-01-15T09:30:00Z",
            "updatedAt": "2024-01-15T09:30:00Z"
          }
        ],
        "host": "example.com",
        "hostRedundancyAllowed": true,
        "followingCount": 0,
        "followersCount": 0,
        "createdAt": "2024-01-15T09:30:00Z",
        "updatedAt": "2024-01-15T09:30:00Z",
        "displayName": "string",
        "description": "string"
      }
    }
  ]
}

Parameters

idid | UUIDv4 | shortUUIDrequiredpath

The object id, uuid or short uuid

startinteger>= 0query

Offset used to paginate results

countinteger[1, 100]15query

Number of items to return

sortstring-createdAt-totalRepliesquery

Sort comments by criteria

x-peertube-video-passwordstringheader

Required on password protected video

Response

200OKCommentThreadResponse

successful operation

Response fields application/json

totalinteger

Total threads (included deleted ones) on this video

totalNotDeletedCommentsinteger

Total not-deleted threads (included deleted ones) on this video

dataArray<VideoComment>

Show child attributes

idid>= 1

Example

urlurl<url>

texttext<html>

Text of the comment

Example

This video is wonderful!

threadIdid>= 1

Example

inReplyToCommentIdid | null

Show child attributes

id>= 1

Example

videoIdid

object id for the video

Show child attributes

id>= 1

Example

createdAtcreatedAt<date-time>

updatedAtupdatedAt<date-time>

deletedAtstring<date-time> | nullnull

isDeletedbooleanfalse

heldForReviewheldForReview

totalRepliesFromVideoAuthorinteger>= 0

totalRepliesinteger>= 0

accountActor & any

Show child attributes

idid>= 1

Example

Same fields as data.videoId

urlstring<url>

nameusername

immutable name of the actor, used to find or mention it

Show child attributes

immutable name of the user, used to find or mention its actor

username

Example

chocobozzz

avatarsArray<ActorImage>

Show child attributes

pathstring | nulldeprecated

Deprecated in PeerTube v8.0, use fileUrl instead. Null if the file is stored in object storage: use the non-deprecated field instead.

fileUrlstring

PeerTube >= 7.1

widthinteger

heightinteger

PeerTube >= 7.3

createdAtstring<date-time>

updatedAtstring<date-time>

hoststring<hostname>

server on which the actor is resident

hostRedundancyAllowedboolean | null

whether this actor's host allows redundancy of its videos

followingCountinteger>= 0

number of actors subscribed to by this actor, as seen by this instance

followersCountinteger>= 0

number of followers of this actor, as seen by this instance

createdAtstring<date-time>

updatedAtstring<date-time>

userIdid | null

object id for the user tied to this account

Show child attributes

id>= 1

Example

displayNamestring

editable name of the account, displayed in its representations

descriptionstring | null

text or bio displayed on the account's profile

Docs by Sourcey