Video API, REST: Channel.list
List channels for organization.
HTTP request
GET https://video.api.cloud.yandex.net/video/v1/channels
Query parameters
Parameter | Description |
---|---|
organizationId | ID of the organization. |
pageSize | The maximum number of the results per page to return. Default value: 100. |
pageToken | Page token for getting the next page of the result. |
orderBy | By which column the listing should be ordered and in which direction, format is "createdAt desc". "id asc" if omitted. Possible fields: ["id", "createdAt", "updatedAt"] Both snake_case and camelCase are supported for fields. |
filter | Filter expression that filters resources listed in the response. Expressions are composed of terms connected by logic operators. Value in quotes: |
Response
HTTP Code: 200 - OK
{
"channels": [
{
"id": "string",
"organizationId": "string",
"title": "string",
"description": "string",
"createdAt": "string",
"updatedAt": "string",
"labels": "object"
}
],
"nextPageToken": "string"
}
Field | Description |
---|---|
channels[] | object List of channels for specific organization. |
channels[]. id |
string ID of the channel. |
channels[]. organizationId |
string ID of the organization where channel should be created. |
channels[]. title |
string Channel title. |
channels[]. description |
string Channel description. |
channels[]. createdAt |
string (date-time) Time when channel was created. String in RFC3339 text format. The range of possible values is from 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). |
channels[]. updatedAt |
string (date-time) Time of last channel update. String in RFC3339 text format. The range of possible values is from 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). |
channels[]. labels |
object Custom labels as |
nextPageToken | string Token for getting the next page. |