Method: claims.list
Stay organized with collections
Save and categorize content based on your preferences.
Retrieves a list of claims administered by the content owner associated with the currently authenticated user. Results are sorted in descending order of creation time.
HTTP request
GET https://youtubepartner.googleapis.com/youtube/partner/v1/claims
The URL uses gRPC Transcoding
syntax.
Query parameters
| Parameters |
assetId
|
string
Use the claimSearch.list
method's assetId
parameter to search for claim snippets by asset ID. You can then retrieve the claim
resources for those claims by using this method's id
parameter to specify a comma-separated list of claim IDs.
|
id
|
string
The id
parameter specifies a list of comma-separated YouTube claim IDs 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. For example, set this parameter to the value of the nextPageToken
value from the previous API response to retrieve the next page of search results.
|
q
|
string
Use the claimSearch.list
method's q
parameter to search for claim snippets that match a particular query string. You can then retrieve the claim
resources for those claims by using this method's id
parameter to specify a comma-separated list of claim IDs.
|
videoId
|
string
Use the claimSearch.list
method's videoId
parameter to search for claim snippets by video ID. You can then retrieve the claim
resources for those claims by using this method's id
parameter to specify a comma-separated list of claim IDs.
|
Request body
The request body must be empty.
Response body
A paginated list of claims returned in response to a claims.list
call.
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#claimList
.
|
pageInfo
|
object ( PageInfo
)
The pageInfo
object encapsulates paging information for the result set.
|
items[]
|
object ( Claim
)
A list of claims 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 in the result set.
|
previousPageToken
|
string
The token that can be used as the value of the pageToken
parameter to retrieve the previous page in the result set.
|
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 claims associated with the authenticated user's content owner, sorted by creation time in descending order.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request uses a \u003ccode\u003eGET\u003c/code\u003e method with a specific URL and supports gRPC Transcoding syntax.\u003c/p\u003e\n"],["\u003cp\u003eSeveral query parameters, such as \u003ccode\u003eassetId\u003c/code\u003e, \u003ccode\u003eid\u003c/code\u003e, \u003ccode\u003evideoId\u003c/code\u003e, and \u003ccode\u003eq\u003c/code\u003e, allow for filtering and specifying the claims to retrieve.\u003c/p\u003e\n"],["\u003cp\u003eThe response body is a paginated list of claims, with fields like \u003ccode\u003ekind\u003c/code\u003e, \u003ccode\u003epageInfo\u003c/code\u003e, \u003ccode\u003eitems\u003c/code\u003e, \u003ccode\u003enextPageToken\u003c/code\u003e, and \u003ccode\u003epreviousPageToken\u003c/code\u003e providing details about the claims and pagination.\u003c/p\u003e\n"],["\u003cp\u003eThe required authorization scope for this request is \u003ccode\u003ehttps://www.googleapis.com/auth/youtubepartner\u003c/code\u003e.\u003c/p\u003e\n"]]],["This describes retrieving claims via a `GET` request to `https://youtubepartner.googleapis.com/youtube/partner/v1/claims`. Users can filter claims using query parameters like `assetId`, `id`, `videoId`, `q`, `pageToken`, and `onBehalfOfContentOwner`. The request body is empty. The response is a paginated JSON list of claims (`items`), along with `pageInfo`, `nextPageToken`, and `previousPageToken`. This action requires `https://www.googleapis.com/auth/youtubepartner` authorization scope.\n"],null,["# Method: claims.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.ClaimListResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nRetrieves a list of claims administered by the content owner associated with the currently authenticated user. Results are sorted in descending order of creation time.\n\n### HTTP request\n\n`GET https://youtubepartner.googleapis.com/youtube/partner/v1/claims`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `assetId` | `string` Use the `claimSearch.list` method's [assetId](/youtube/partner/reference/rest/v1/claimSearch/list#assetId) parameter to search for claim snippets by asset ID. You can then retrieve the `claim` resources for those claims by using this method's `id` parameter to specify a comma-separated list of claim IDs. |\n| `id` | `string` The `id` parameter specifies a list of comma-separated YouTube claim IDs 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. For example, set this parameter to the value of the `nextPageToken` value from the previous API response to retrieve the next page of search results. |\n| `q` | `string` Use the `claimSearch.list` method's [q](/youtube/partner/reference/rest/v1/claimSearch/list#q) parameter to search for claim snippets that match a particular query string. You can then retrieve the `claim` resources for those claims by using this method's `id` parameter to specify a comma-separated list of claim IDs. |\n| `videoId` | `string` Use the `claimSearch.list` method's [videoId](/youtube/partner/reference/rest/v1/claimSearch/list#videoId) parameter to search for claim snippets by video ID. You can then retrieve the `claim` resources for those claims by using this method's `id` parameter to specify a comma-separated list of claim IDs. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nA paginated list of claims returned in response to a `claims.list` call.\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/claims#Claim) } ], \"nextPageToken\": string, \"previousPageToken\": string } ``` |\n\n| Fields ||\n|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` The type of the API response. For this operation, the value is `youtubePartner#claimList`. |\n| `pageInfo` | `object (`[PageInfo](/youtube/partner/reference/rest/v1/PageInfo)`)` The `pageInfo` object encapsulates paging information for the result set. |\n| `items[]` | `object (`[Claim](/youtube/partner/reference/rest/v1/claims#Claim)`)` A list of claims 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 in the result set. |\n| `previousPageToken` | `string` The token that can be used as the value of the `pageToken` parameter to retrieve the previous page in the result set. |\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)."]]
