Comments: list

Returns a list of comments that match the API request parameters.

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/comments

Parameters

The following table lists the parameters that this query supports. All of the parameters listed are query parameters.

Parameters
Required parameters
partstring
The part parameter specifies a comma-separated list of one or more comment resource properties that the API response will include.

The following list contains the part names that you can include in the parameter value:
  • id
  • snippet
Filters (specify exactly one of the following parameters)
idstring
The id parameter specifies a comma-separated list of comment IDs for the resources that are being retrieved. In a comment resource, the id property specifies the comment's ID.
parentIdstring
The parentId parameter specifies the ID of the comment for which replies should be retrieved.

Note: YouTube currently supports replies only for top-level comments. However, replies to replies may be supported in the future.
Optional parameters
maxResultsunsigned integer
The maxResults parameter specifies the maximum number of items that should be returned in the result set.

Note: This parameter is not supported for use in conjunction with the id parameter. Acceptable values are 1 to 100, inclusive. The default value is 20.
pageTokenstring
The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken property identifies the next page of the result that can be retrieved.

Note: This parameter is not supported for use in conjunction with the id parameter.
textFormatstring
This parameter indicates whether the API should return comments formatted as HTML or as plain text. The default value is html.

Acceptable values are:
  • html – Returns the comments in HTML format. This is the default value.
  • plainText – Returns the comments in plain text format.

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#commentListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    comment Resource
  ]
}

Properties

The following table defines the properties that appear in this resource:

Properties
kindstring
Identifies the API resource's type. The value will be youtube#commentListResponse.
etagetag
The Etag of this resource.
nextPageTokenstring
The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set.
pageInfoobject
The pageInfo object encapsulates paging information for the result set.
pageInfo.totalResultsinteger
The total number of results in the result set.
pageInfo.resultsPerPageinteger
The number of results included in the API response.
items[]list
A list of comments 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 typeError detailDescription
badRequest (400)operationNotSupportedThe id filter is only compatible with comments based on Google+.
forbidden (403)forbiddenOne or more of the requested comments cannot be retrieved due to insufficient permissions. The request might not be properly authorized.
notFound (404)commentNotFoundOne or more of the specified comments cannot be found. Check the values of the request's id and parentId parameters to ensure that they are correct.

Try it!

Use the APIs Explorer to call this API and see the API request and response.