Contact UsGet started

Video API, REST: Channel.List

Written by
Updated at April 24, 2025

List channels for organization.

HTTP request

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

Query parameters

Field

Description

organizationId

string

Required field. ID of the organization.

pageSize

string (int64)

The maximum number of the results per page to return.
Default value: 100.

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 " " (e.g. "createdAt desc").
Default: "id asc".
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.
If value contains spaces or quotes,
it should be in quotes (' or ") with the inner quotes being backslash escaped.
Supported logical operators: ["AND", "OR"].
Supported string match operators: ["=", "!=", ":"].
Operator ":" stands for substring matching.
Filter expressions may also contain parentheses to group logical operands.
Example: key1='value' AND (key2!='\'value\'' OR key2:"\"value\"")
Supported fields: ["id", "title"].
Both snake_case and camelCase are supported for fields.

Response

HTTP Code: 200 - OK

{
  "channels": [
    {
      "id": "string",
      "organizationId": "string",
      "title": "string",
      "description": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "labels": "object",
      "settings": {
        "advertisement": {
          // Includes only one of the fields `yandexDirect`
          "yandexDirect": {
            "enable": "boolean",
            "pageId": "string",
            "category": "string"
          }
          // end of the list of possible fields
        },
        "refererVerification": {
          "enable": "boolean",
          "allowedDomains": [
            "string"
          ]
        }
      }
    }
  ],
  "nextPageToken": "string"
}

Field

Description

channels[]

Channel

List of channels for specific organization.

nextPageToken

string

Token for getting the next page.

Channel

Root entity for content separation.

Field

Description

id

string

ID of the channel.

organizationId

string

ID of the organization where channel should be created.

title

string

Channel title.

description

string

Channel description.

createdAt

string (date-time)

Time when channel 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 channel 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).

labels

object (map<string, string>)

Custom labels as key:value pairs. Maximum 64 per resource.

settings

ChannelSettings

Channel settings.

ChannelSettings

Channel settings.

Field

Description

advertisement

AdvertisementSettings

Advertisement settings.

refererVerification

RefererVerificationSettings

Referer verification settings

AdvertisementSettings

Advertisement settings.

Field

Description

yandexDirect

YandexDirect

Includes only one of the fields yandexDirect.

Advertisement provider.

YandexDirect

YandexDirect provider settings.

Field

Description

enable

boolean

Enable Partner Ad for Live and VOD content.

pageId

string (int64)

Advertisement page ID.

category

string (int64)

Advertisement category.

RefererVerificationSettings

Referer verification settings.

Field

Description

enable

boolean

Enable verification

allowedDomains[]

string

List of available domains
Previous
Get
Next
Create