PeerTube

List video playlists

Live Test Server (live data - latest nightly version)

https://peertube2.cpy.re/api/v1

GET

/video-playlists

Video Playlists

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://peertube2.cpy.re/api/v1/video-playlists'

Response Example

{
    "data": [
        {
            "createdAt": "2019-08-24T14:15:22Z",
            "description": "string",
            "displayName": "string",
            "id": 42,
            "isLocal": true,
            "ownerAccount": {
                "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"
            },
            "privacy": {
                "id": 1,
                "label": "string"
            },
            "shortUUID": "2y84q2MQUMWPbiEcxNXMgC",
            "thumbnailPath": "string",
            "type": {
                "id": 1,
                "label": "string"
            },
            "updatedAt": "2019-08-24T14:15:22Z",
            "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d",
            "videoChannel": {
                "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"
            },
            "videoLength": 0
        }
    ],
    "total": 1
}

Request

Query Params

start

integer

optional

Offset used to paginate results

count

integer

optional

Number of items to return

sort

string

optional

Sort column

Responses

🟢200successful operation

application/json

Body

data

array[object (VideoPlaylist) {14}]

optional

createdAt

string <date-time>

optional

description

string

optional

>= 3 characters<= 1000 characters

displayName

string

optional

>= 1 characters<= 120 characters

integer

optional

>= 1

Example:

isLocal

boolean

optional

ownerAccount

object (AccountSummary)

optional

privacy

object (VideoPlaylistPrivacyConstant)

optional

shortUUID

string

optional

translation of a uuid v4 with a bigger alphabet to have a shorter uuid

Example:

2y84q2MQUMWPbiEcxNXMgC

thumbnailPath

string

optional

type

object (VideoPlaylistTypeConstant)

optional

updatedAt

string <date-time>

optional

uuid

string <uuid>

optional

>= 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}$

videoChannel

object (VideoChannelSummary)

optional

videoLength

integer

optional

>= 0

total

integer

optional

Example:

Modified at 2022-09-10 22:29:50

Check video exists in my playlists

Create a video playlist