Method: whitelists.list
Stay organized with collections
Save and categorize content based on your preferences.
Retrieves a list of whitelisted channels for a content owner.
HTTP request
GET https://youtubepartner.googleapis.com/youtube/partner/v1/whitelists
The URL uses gRPC Transcoding
syntax.
Query parameters
| Parameters |
id
|
string
The id
parameter specifies a comma-separated list of YouTube channel IDs that identify the whitelisted channels you want to retrieve.
|
onBehalfOfContentOwner
|
string
The onBehalfOfContentOwner
parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners.
|
pageToken
|
string
The pageToken
parameter specifies a token that identifies a particular page of results to return. Set this parameter to the value of the nextPageToken
value from the previous API response to retrieve the next page of results.
|
Request body
The request body must be empty.
Response body
A paginated list whitelist
resources returned in response to a whitelist.list
request.
If successful, the response body contains data with the following structure:
| Fields |
kind
|
string
The type of the API response. For this operation, the value is youtubePartner#whitelistList
.
|
pageInfo
|
object ( PageInfo
)
The pageInfo
object encapsulates paging information for the result set.
|
items[]
|
object ( Whitelist
)
A list of whitelist
resources that match the request criteria.
|
nextPageToken
|
string
The token that can be used as the value of the pageToken
parameter to retrieve the next page of results.
|
Authorization scopes
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/youtubepartner
For more information, see the OAuth 2.0 Overview
.
All rights reserved. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-20 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-20 UTC."],[[["\u003cp\u003eThis endpoint retrieves a list of whitelisted YouTube channels associated with a specific content owner.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request is a \u003ccode\u003eGET\u003c/code\u003e method to the provided URL, using gRPC Transcoding syntax.\u003c/p\u003e\n"],["\u003cp\u003eRequests require parameters such as \u003ccode\u003eid\u003c/code\u003e (channel IDs), \u003ccode\u003eonBehalfOfContentOwner\u003c/code\u003e (content owner identification), and \u003ccode\u003epageToken\u003c/code\u003e (for pagination) which can be specified as query parameters.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must be empty, while a successful response returns a paginated JSON list of whitelist resources, including metadata like \u003ccode\u003ekind\u003c/code\u003e, \u003ccode\u003epageInfo\u003c/code\u003e, \u003ccode\u003eitems\u003c/code\u003e, and \u003ccode\u003enextPageToken\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization for this request requires the \u003ccode\u003ehttps://www.googleapis.com/auth/youtubepartner\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],["This document details how to retrieve a list of whitelisted YouTube channels for a content owner using a `GET` request to `https://youtubepartner.googleapis.com/youtube/partner/v1/whitelists`. Key actions include: using query parameters like `id` (comma-separated channel IDs), `onBehalfOfContentOwner` (content owner identifier), and `pageToken` (for pagination). The request body must be empty. The response body is a JSON object containing a paginated list of `whitelist` resources, with fields like `kind`, `pageInfo`, `items`, and `nextPageToken`. The request needs `https://www.googleapis.com/auth/youtubepartner` OAuth scope.\n"],null,["# Method: whitelists.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.WhitelistListResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nRetrieves a list of whitelisted channels for a content owner.\n\n### HTTP request\n\n`GET https://youtubepartner.googleapis.com/youtube/partner/v1/whitelists`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `id` | `string` The `id` parameter specifies a comma-separated list of YouTube channel IDs that identify the whitelisted channels you want to retrieve. |\n| `onBehalfOfContentOwner` | `string` The `onBehalfOfContentOwner` parameter identifies the content owner that the user is acting on behalf of. This parameter supports users whose accounts are associated with multiple content owners. |\n| `pageToken` | `string` The `pageToken` parameter specifies a token that identifies a particular page of results to return. Set this parameter to the value of the `nextPageToken` value from the previous API response to retrieve the next page of results. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nA paginated list `whitelist` resources returned in response to a `whitelist.list` request.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"pageInfo\": { object (/youtube/partner/reference/rest/v1/PageInfo) }, \"items\": [ { object (/youtube/partner/reference/rest/v1/whitelists#Whitelist) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` The type of the API response. For this operation, the value is `youtubePartner#whitelistList`. |\n| `pageInfo` | `object (`[PageInfo](/youtube/partner/reference/rest/v1/PageInfo)`)` The `pageInfo` object encapsulates paging information for the result set. |\n| `items[]` | `object (`[Whitelist](/youtube/partner/reference/rest/v1/whitelists#Whitelist)`)` A list of `whitelist` resources that match the request criteria. |\n| `nextPageToken` | `string` The token that can be used as the value of the `pageToken` parameter to retrieve the next page of results. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/youtubepartner`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]
