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. Try it now.
Request
HTTP request
GET https://www.googleapis.com/youtube/v3/playlists
Parameters
The table below lists the parameters that this query supports. All of the parameters listed are query parameters.
| Parameter name | Value | Description |
|---|---|---|
| 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. The part names that you can include in the parameter value are id, snippet, and status.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, tags, and timeCreated. As such, if you set part=snippet, the API response will contain all of those properties. |
| 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 | ||
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. |
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,
"pageInfo": {
"totalResults": integer,
"resultsPerPage": integer
},
"nextPageToken": string,
"prevPageToken": string,
"items": [
playlists Resource
]
}
Properties
The following table defines the properties that appear in this resource:
| Property name | Value | Description |
|---|---|---|
kind |
string |
The type of the API response. For this operation, the value will be youtube#playlistListResponse. |
etag |
etag |
The ETag of the response. |
pageInfo |
nested 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. |
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. |
items[] |
list |
A list of playlists that match the request criteria. |
Try it!
Use the API Explorer to call this method on live data and see the API request and response.