Playlists: list
Stay organized with collections
Save and categorize content based on your preferences.
Returns a collection of playlists that match the API request parameters. For example, you can retrieve all playlists that the authenticated user owns, or you can retrieve one or more playlists by their unique IDs.
Quota impact:
A call to this method has a
quota cost
of 1 unit.
Common use cases
Request
HTTP request
GET https://www.googleapis.com/youtube/v3/playlists
Parameters
The following table lists the parameters that this query supports. All of the parameters listed are query parameters.
Parameters
|
Required parameters
|
part
|
string
The
part
parameter specifies a comma-separated list of one or more
playlist
resource properties that the API response will include.
If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a
playlist
resource, the
snippet
property contains properties like
author
,
title
,
description
, and
timeCreated
. As such, if you set
part=snippet
, the API response will contain all of those properties.
The following list contains the
part
names that you can include in the parameter value:
contentDetails
id
localizations
player
snippet
status
|
Filters
(specify exactly one of the following parameters)
|
channelId
|
string
This value indicates that the API should only return the specified channel's playlists.
|
id
|
string
The
id
parameter specifies a comma-separated list of the YouTube playlist ID(s) for the resource(s) that are being retrieved. In a
playlist
resource, the
id
property specifies the playlist's YouTube playlist ID.
|
mine
|
boolean
This parameter can only be used in a properly
authorized request
. Set this parameter's value to
true
to instruct the API to only return playlists owned by the authenticated user.
|
Optional parameters
|
hl
|
string
The
hl
parameter instructs the API to retrieve localized resource metadata for a specific
application language that the YouTube website supports
. The parameter value must be a language code included in the list returned by the
i18nLanguages.list
method.
If localized resource details are available in that language, the resource's
snippet.localized
object will contain the localized values. However, if localized details are not available, the
snippet.localized
object will contain resource details in the resource's
default language
.
|
maxResults
|
unsigned integer
The
maxResults
parameter specifies the maximum number of items that should be returned in the result set. Acceptable values are
0
to
50
, inclusive. The default value is
5
.
|
onBehalfOfContentOwner
|
string
This parameter can only be used in a properly
authorized request
.
Note:
This parameter is intended exclusively for YouTube content partners.
The
onBehalfOfContentOwner
parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The CMS account that the user authenticates with must be linked to the specified YouTube content owner.
|
onBehalfOfContentOwnerChannel
|
string
This parameter can only be used in a properly
authorized request
.
Note:
This parameter is intended exclusively for YouTube content partners.
The
onBehalfOfContentOwnerChannel
parameter specifies the YouTube channel ID of the channel to which a video is being added. This parameter is required when a request specifies a value for the
onBehalfOfContentOwner
parameter, and it can only be used in conjunction with that parameter. In addition, the request must be authorized using a CMS account that is linked to the content owner that the
onBehalfOfContentOwner
parameter specifies. Finally, the channel that the
onBehalfOfContentOwnerChannel
parameter value specifies must be linked to the content owner that the
onBehalfOfContentOwner
parameter specifies.
This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and perform actions on behalf of the channel specified in the parameter value, without having to provide authentication credentials for each separate channel.
|
pageToken
|
string
The
pageToken
parameter identifies a specific page in the result set that should be returned. In an API response, the
nextPageToken
and
prevPageToken
properties identify other pages that could be retrieved.
|
Request body
Do not provide a request body when calling this method.
Response
If successful, this method returns a response body with the following structure:
{
"kind": "youtube#playlistListResponse",
"etag":
etag
,
"nextPageToken":
string
,
"prevPageToken":
string
,
"pageInfo": {
"totalResults":
integer
,
"resultsPerPage":
integer
},
"items": [
playlist Resource
]
}
Properties
The following table defines the properties that appear in this resource:
Properties
|
kind
|
string
Identifies the API resource's type. The value will be
youtube#playlistListResponse
.
|
etag
|
etag
The Etag of this resource.
|
nextPageToken
|
string
The token that can be used as the value of the
pageToken
parameter to retrieve the next page in the result set.
|
prevPageToken
|
string
The token that can be used as the value of the
pageToken
parameter to retrieve the previous page in the result set.
|
pageInfo
|
object
The
pageInfo
object encapsulates paging information for the result set.
|
pageInfo.
totalResults
|
integer
The total number of results in the result set.
|
pageInfo.
resultsPerPage
|
integer
The number of results included in the API response.
|
items[]
|
list
A list of playlists that match the request criteria.
|
Errors
The following table identifies error messages that the API could return in response to a call to this method. Please see the
error message
documentation for more detail.
Error type
|
Error detail
|
Description
|
forbidden (403)
|
channelClosed
|
The channel specified in the
channelId
parameter has been closed.
|
forbidden (403)
|
channelSuspended
|
The channel specified in the
channelId
parameter has been suspended.
|
forbidden (403)
|
playlistForbidden
|
The playlist identified with the request's
id
parameter does not support the request or the request is not properly authorized.
|
notFound (404)
|
channelNotFound
|
The channel specified in the
channelId
parameter cannot be found.
|
notFound (404)
|
playlistNotFound
|
The playlist identified with the request's
id
parameter cannot be found.
|
invalidValue (400)
|
playlistOperationUnsupported
|
The API does not support the ability to list the specified playlist. For example, you can't list your watch later playlist.
|
Try it!
Use the
APIs Explorer
to call this API and see the API request and response.
Except as otherwise noted, the content of this page is licensed under the
Creative Commons Attribution 4.0 License
, and code samples are licensed under the
Apache 2.0 License
. For details, see the
Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-04-26 UTC.
[{
"type": "thumb-down",
"id": "missingTheInformationINeed",
"label":"Missing the information I need"
},{
"type": "thumb-down",
"id": "tooComplicatedTooManySteps",
"label":"Too complicated / too many steps"
},{
"type": "thumb-down",
"id": "outOfDate",
"label":"Out of date"
},{
"type": "thumb-down",
"id": "samplesCodeIssue",
"label":"Samples / code issue"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]