View as Markdown
Google Docs icon

Google Docs ACTION

List Comments

List the comments on a Google Doc, including each comment's author, plain text and HTML content, the document text it is anchored to, whether it is resolved, and its full reply thread. Comments on a Doc are served by the Drive API, so the document ID doubles as the file ID. Use Find Document first to resolve a document's name to its ID. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Google Docs account once, then configure and run List Comments from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "google_docs-list-comments",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    google_docs: { authProvisionId: "apn_xxxxxxx" },
    documentId: "Document ID",
    includeDeleted: true,
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

List Comments inputs
Property Type Description
documentId Document ID string
The ID of the Google Doc. This is the long string in the document's URL: https://docs.google.com/document/d/{DOCUMENT_ID}/edit. Use Find Document to resolve a document's name to its ID.
Required
includeDeleted Include Deleted boolean
Whether to include deleted comments. Deleted comments are returned without their original content. Defaults to false.
Optional
startModifiedTime Start Modified Time string
Only return comments modified at or after this time, as an RFC 3339 timestamp (e.g. 2026-01-31T00:00:00Z). A comment's modified time also changes when any of its replies changes, so this returns recently-active threads. Leave blank to return all comments.
Optional
limit Limit integer
Maximum number of comments to return (min 1, max 500). Defaults to 100.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
google_docs-list-comments
Version
0.0.5
App
Google Docs
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes