The YouTube Data API (v3) is an experimental API version, which means it is still in development. We'll be adding many more features to the API while it is still an experimental version. Until the experimental label is removed, however, the Deprecation Policy for YouTube APIs won't apply to this version as discussed in the API Terms of Service.
Returns subscription resources that match the API request criteria. Try it now.
Request
HTTP request
GET https://www.googleapis.com/youtube/v3/subscriptions
Parameters
Parameter name | Value | Description |
---|---|---|
Required parameters | ||
part |
string |
The part parameter specifies a comma-separated list of one or more subscription resource properties that the API response will include. The part names that you can include in the parameter value are id , snippet , and contentDetails .If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a subscription resource, the snippet property contains other properties, such as a display title for the subscription. If you set part=snippet , the API response will also contain all of those nested properties. |
Filters (specify exactly one of the following parameters) | ||
channelId |
string |
The channelId parameter specifies a YouTube channel ID. The API will only return that channel's subscriptions. |
id |
string |
The id parameter specifies a comma-separated list of the YouTube subscription ID(s) for the resource(s) that are being retrieved. In a subscription resource, the id property specifies the YouTube subscription ID. |
mine |
boolean |
This parameter can only be used in a properly authorized request. Set this parameter's value to true to retrieve a feed of the authenticated user's subscriptions. |
Optional parameters | ||
forChannelId |
string |
The forChannelId parameter specifies a comma-separated list of channel IDs. The API response will then only contain subscriptions matching those channels. |
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 . |
order |
string |
The order parameter specifies the method that will be used to sort resources in the API response. The default value is SUBSCRIPTION_ORDER_RELEVANCE .Acceptable values are:
|
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#subscriptionListResponse", "etag": etag, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "nextPageToken": string, "prevPageToken": string, "items": [ subscriptions 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#subscriptionListResponse . |
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 subscriptions 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.