Contact UsGet started
© 2024 Direct Cursus Technology L.L.C.

Video API, REST: Playlist.List

Written by
Updated at November 26, 2024

List playlists for a channel.

HTTP request

GET https://video.api.cloud.yandex.net/video/v1/playlists

Query parameters

Field

Description

channelId

string

Required field. ID of the channel.

pageSize

string (int64)

The maximum number of the results per page to return.

pageToken

string

Page token for getting the next page of the result.

orderBy

string

By which column the listing should be ordered and in which direction,
format is "createdAt desc". "id asc" if omitted.
Possible fields: ["id", "title", "createdAt", "updatedAt"]
Both snake_case and camelCase are supported for fields.

filter

string

Filter expression that filters resources listed in the response.
Expressions are composed of terms connected by logic operators.
Example: "key1=value AND key2=value"
Supported operators: ["AND"].
Supported fields: ["title"]
Both snake_case and camelCase are supported for fields.

Response

HTTP Code: 200 - OK

{
  "playlists": [
    {
      "id": "string",
      "channelId": "string",
      "title": "string",
      "description": "string",
      "items": [
        {
          // Includes only one of the fields `videoId`, `episodeId`
          "videoId": "string",
          "episodeId": "string",
          // end of the list of possible fields
          "position": "string"
        }
      ],
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "nextPageToken": "string"
}

Field

Description

playlists[]

Playlist

List of playlists for specific channel.

nextPageToken

string

Token for getting the next page.

Playlist

Entity representing an ordered list of videos or episodes.

Field

Description

id

string

ID of the playlist.

channelId

string

ID of the channel to create the playlist in.

title

string

Playlist title.

description

string

Playlist description.

items[]

PlaylistItem

List of playlist items.

createdAt

string (date-time)

Time when playlist was created.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

updatedAt

string (date-time)

Time of last playlist update.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

PlaylistItem

Field

Description

videoId

string

ID of the video.

Includes only one of the fields videoId, episodeId.

episodeId

string

ID of the episode.

Includes only one of the fields videoId, episodeId.

position

string (int64)

Item position (zero-indexed).
Previous
Get
Next
Create