List Comment Threads

youtube.list_comment_threads
ActionChat & messagingconnection required

Calls youtube v3 GET /youtube/v3/commentThreads.

Retrieves a list of resources, possibly filtered.

Connection

Required
Yes — the node will not save without one
Auth type
OAuth 2.0
Providers
YouTube
Secret shape
{"client_id", "client_secret", "refresh_token"}
Resolved by
config.connection_id, else node.connection_id

Configuration

11 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.

FieldTypeRequiredDefaultConstraintsExample
part
The *part* parameter specifies a comma-separated list of one or more commentThread resource properties that the API response will include. Required.
stringYes———
max_results
Max results, 1-100. Optional; default 20.
integerNo—1–100—
page_token
The previous response's nextPageToken; blank = first page.
stringNo———
video_id
Returns the comment threads of the specified video. Optional.
stringNo———
channel_id
Returns the comment threads for all the channel comments (ie does not include comments left on videos). Optional.
stringNo———
id
Returns the comment threads with the given IDs for Stubby or Apiary. Optional.
stringNo———
all_threads_related_to_channel_id
Returns the comment threads of all videos of the channel and the channel comments as well. Optional.
stringNo———
order
Order — YouTube accepts only the listed values.
stringNo—one of "orderUnspecified", "time", "relevance"—
search_terms
Limits the returned comment threads to those matching the specified key words. Optional.
stringNo———
text_format
The requested text format for the returned comments. Optional.
stringNo—one of "textFormatUnspecified", "html", "plainText"—
moderation_status
Limits the returned comment threads to those with the specified moderation status. Optional.
stringNo—one of "published", "heldForReview", "likelySpam", "rejected"—
  • At least one of video_id, channel_id, id, all_threads_related_to_channel_id must be set.

Output

One shape.

result

Extra keys beyond the ones listed can appear.

FieldTypeExample
etag
string—
eventId
string—
items
array—
kind
string—
nextPageToken
string—
pageInfo
object—
tokenPagination
object—
visitorId
string—
{
  "etag": "",
  "eventId": "",
  "items": [],
  "kind": "",
  "nextPageToken": "",
  "pageInfo": {},
  "tokenPagination": {},
  "visitorId": ""
}

Related YouTube nodes

See List Comment Threads run in a workflow.

In a technical demo we add the YouTube connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.