PeerTube
  1. Videos
PeerTube
  • Abuses
    • List abuses
      GET
    • Report an abuse
      POST
    • Delete an abuse
      DELETE
    • Update an abuse
      PUT
    • List messages of an abuse
      GET
    • Add message to an abuse
      POST
    • Delete an abuse message
      DELETE
    • List my abuses
      GET
  • Accounts
    • List accounts
      GET
    • Get an account
      GET
    • List ratings of an account
      GET
    • List videos of an account
      GET
  • Video Channels
    • List video channels of an account
      GET
    • List video channels
      GET
    • Create a video channel
      POST
    • Delete a video channel
      DELETE
    • Get a video channel
      GET
    • Update a video channel
      PUT
    • Delete channel avatar
      DELETE
    • Update channel avatar
      POST
    • Delete channel banner
      DELETE
    • Update channel banner
      POST
  • Config
    • Get instance public configuration
      GET
    • Get instance "About" information
      GET
    • Delete instance runtime configuration
      DELETE
    • Get instance runtime configuration
      GET
    • Set instance runtime configuration
      PUT
  • Homepage
    • Get instance custom homepage
    • Set instance custom homepage
  • Feeds
    • List videos of subscriptions tied to a token
    • List comments on videos
    • List videos
  • Job
    • List instance jobs
  • Session
    • Login prerequisite
    • Logout
    • Login
  • Plugins
    • List plugins
    • List available plugins
    • Install a plugin
    • Uninstall a plugin
    • Update a plugin
    • Get a plugin
    • Get a plugin's public settings
    • Get a plugin's registered settings
    • Set a plugin's settings
  • Search
    • Search channels
    • Search playlists
    • Search videos
  • Account Blocks
    • List account blocks
    • Block an account
    • Unblock an account by its handle
  • Server Blocks
    • List server blocks
    • Block a server
    • Unblock a server by its domain
  • Instance Follows
    • List instances following the server
    • Remove or reject a follower to your server
    • Accept a pending follower to your server
    • Reject a pending follower to your server
    • List instances followed by the server
    • Follow a list of actors (PeerTube instance, channel or account)
    • Unfollow an actor (PeerTube instance, channel or account)
  • Video Mirroring
    • List videos being mirrored
    • Mirror a video
    • Delete a mirror done on a video
  • Instance Redundancy
    • Update a server redundancy policy
  • Users
    • List users
    • Create a user
    • Resend user verification link
    • Register a user
    • Delete a user
    • Get a user
    • Update a user
    • Verify a user
  • My User
    • Get my user information
    • Update my user information
    • Delete my avatar
    • Update my user avatar
    • Get my user used quota
    • Get videos of my user
    • Get rate of my user for a video
  • My History
    • List watched videos history
    • Clear video history
  • My Notifications
    • Update my notification settings
    • List my notifications
    • Mark notifications as read by their id
    • Mark all my notification as read
  • My Subscriptions
    • Get my user subscriptions
    • Add subscription to my user
    • Get if subscriptions exist for my user
    • List videos of subscriptions of my user
    • Delete subscription of my user
    • Get subscription of my user
  • Video Playlists
    • Check video exists in my playlists
    • List video playlists
    • Create a video playlist
    • List available playlist privacy policies
    • Delete a video playlist
    • Get a video playlist
    • Update a video playlist
    • Reorder a playlist
    • Delete an element from a playlist
    • Update a playlist element
  • Videos
    • Get video imports of my user
      GET
    • List videos of a playlist
      GET
    • Add a video in a playlist
      POST
  • Video
    • List videos of a video channel
    • List videos
    • List available video categories
    • Import a video
    • List available video languages
    • List available video licences
    • List available video privacy policies
    • Upload a video
    • Cancel the resumable upload of a video, deleting any data uploaded so far
    • Initialize the resumable upload of a video
    • Send chunk for the resumable upload of a video
    • Delete a video
    • Get a video
    • Update a video
    • Get complete video description
    • Add a view to a video
    • Set watching progress of a video
  • Video Blocks
    • List video blocks
    • Unblock a video by its id
    • Block a video
  • Live Videos
    • Create a live
    • Get information about a live
    • Update information about a live
  • Video Ownership Change
    • List video ownership changes
    • Accept ownership change request
    • Refuse ownership change request
    • Request ownership change
  • Video Captions
    • List captions of a video
    • Delete a video caption
    • Add or replace a video caption
  • Video Comments
    • List threads of a video
    • Create a thread
    • Get a thread
    • Delete a comment or a reply
    • Reply to a thread of a video
  • Video Rates
    • Like/dislike a video
  1. Videos

List videos of a playlist

Live Test Server (live data - latest nightly version)
https://peertube2.cpy.re/api/v1
Live Test Server (live data - latest nightly version)
https://peertube2.cpy.re/api/v1
GET
/video-playlists/{playlistId}/videos
VideosVideo Playlists
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://peertube2.cpy.re/api/v1/video-playlists//videos'
Response Response Example
{
    "data": [
        {
            "account": {
                "avatar": {
                    "createdAt": "2019-08-24T14:15:22Z",
                    "path": "string",
                    "updatedAt": "2019-08-24T14:15:22Z"
                },
                "displayName": "string",
                "host": "example.com",
                "id": 0,
                "name": "string",
                "url": "string"
            },
            "blacklisted": true,
            "blacklistedReason": "string",
            "category": {
                "id": 15,
                "label": "Science & Technology"
            },
            "channel": {
                "avatar": {
                    "createdAt": "2019-08-24T14:15:22Z",
                    "path": "string",
                    "updatedAt": "2019-08-24T14:15:22Z"
                },
                "displayName": "string",
                "host": "example.com",
                "id": 42,
                "name": "string",
                "url": "string"
            },
            "createdAt": "2017-10-01T10:52:46.396Z",
            "description": "**[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\\r\\n\\r\\n\n**Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**\\r\\n*A decentralized video hosting network, based on fr...\n",
            "dislikes": 7,
            "duration": 1419,
            "embedPath": "/videos/embed/a65bc12f-9383-462e-81ae-8207e8b434ee",
            "id": 42,
            "isLive": true,
            "isLocal": true,
            "language": {
                "id": "en",
                "label": "English"
            },
            "licence": {
                "id": 2,
                "label": "Attribution - Share Alike"
            },
            "likes": 42,
            "name": "What is PeerTube?",
            "nsfw": true,
            "originallyPublishedAt": "2010-10-01T10:52:46.396Z",
            "previewPath": "/lazy-static/previews/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg",
            "privacy": {
                "id": 1,
                "label": "string"
            },
            "publishedAt": "2018-10-01T10:52:46.396Z",
            "scheduledUpdate": {
                "privacy": 1,
                "updateAt": "2019-08-24"
            },
            "shortUUID": "2y84q2MQUMWPbiEcxNXMgC",
            "state": {
                "id": 1,
                "label": "string"
            },
            "thumbnailPath": "/static/thumbnails/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg",
            "updatedAt": "2021-05-04T08:01:01.502Z",
            "userHistory": {
                "currentTime": 0
            },
            "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
            "views": 1337,
            "waitTranscoding": true
        }
    ],
    "total": 1
}

Request

Path Params
playlistId
string 
required
Playlist id

Responses

🟢200successful operation
application/json
Body
data
array[object (Video) {31}] 
optional
<= 100 items
account
object (AccountSummary) 
optional
blacklisted
boolean  | null 
optional
blacklistedReason
string  | null 
optional
category
object 
optional
category in which the video is classified
channel
object (VideoChannelSummary) 
optional
createdAt
string <date-time>
optional
time at which the video object was first drafted
Example:
2017-10-01T10:52:46.396Z
description
string 
optional
truncated description of the video, written in Markdown.
Resolve descriptionPath to get the full description of maximum 10000 characters.
>= 3 characters<= 250 characters
Example:
**[Want to help to translate this video?](https://weblate.framasoft.org/projects/what-is-peertube-video/)**\r\n\r\n **Take back the control of your videos! [#JoinPeertube](https://joinpeertube.org)**\r\n*A decentralized video hosting network, based on fr...
dislikes
integer 
optional
Example:
7
duration
integer 
optional
duration of the video in seconds
Example:
1419
embedPath
string 
optional
Example:
/videos/embed/a65bc12f-9383-462e-81ae-8207e8b434ee
id
integer 
optional
object id for the video
>= 1
Example:
42
isLive
boolean 
optional
isLocal
boolean 
optional
language
object 
optional
main language used in the video
licence
object 
optional
licence under which the video is distributed
likes
integer 
optional
Example:
42
name
string 
optional
title of the video
>= 3 characters<= 120 characters
Example:
What is PeerTube?
nsfw
boolean 
optional
originallyPublishedAt
string <date-time>
optional
used to represent a date of first publication, prior to the practical publication date of publishedAt
Example:
2010-10-01T10:52:46.396Z
previewPath
string 
optional
Example:
/lazy-static/previews/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg
privacy
object 
optional
privacy policy used to distribute the video
publishedAt
string <date-time>
optional
time at which the video was marked as ready for playback (with restrictions depending on privacy). Usually set after a state evolution.
Example:
2018-10-01T10:52:46.396Z
scheduledUpdate
null  | allOf {1} 
optional
shortUUID
string 
optional
translation of a uuid v4 with a bigger alphabet to have a shorter uuid
Example:
2y84q2MQUMWPbiEcxNXMgC
state
object 
optional
represents the internal state of the video processing within the PeerTube instance
thumbnailPath
string 
optional
Example:
/static/thumbnails/a65bc12f-9383-462e-81ae-8207e8b434ee.jpg
updatedAt
string <date-time>
optional
last time the video's metadata was modified
Example:
2021-05-04T08:01:01.502Z
userHistory
object  | null 
optional
uuid
string <uuid>
optional
universal identifier for the video, that can be used across instances
>= 36 characters<= 36 characters
Example:
9c9de5e8-0a1e-484a-b099-e80766180a6d
Match pattern:
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
views
integer 
optional
Example:
1337
waitTranscoding
boolean  | null 
optional
total
integer 
optional
Example:
1
Modified at 2022-09-10 22:29:50
Previous
Get video imports of my user
Next
Add a video in a playlist
Built with