List comments with the Google Drive API

Lists the comments of a file, such as a Google Doc under review, with their replies and whether they are resolved. Google requires fields in this call. Pass nextPageToken as pageToken to read the next page.

Identifier
google_drive_list_comments

The request

POST https://connect.reportei.com/api/tools/google_drive_list_comments/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "fileId": "<fileId>",
    "fields": "<fields>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
fileIdstringYesFile id from List files.
fieldsstringYesFields to return, required by Google, such as nextPageToken,comments(id,content,author/displayName,createdTime,resolved,quotedFileContent/value,replies(content,author/displayName)).
pageSizeintegerNoComments per page, up to 100. The default is 20.
pageTokenstringNoThe nextPageToken of the previous response.
startModifiedTimestringNoOnly comments changed since this moment, RFC 3339.
includeDeletedbooleanNoAlso returns deleted comments, without their content.

Supported connections

Your customer connects their Google Drive account once, with one of the modes below. The same connection serves every tool of the toolkit.

OAuth with your product's app

You register your product's OAuth app once, with POST /api/merchants/credentials/google_drive, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/google_drive_list_comments. It becomes your agent's tool definition with no conversion.

Other Google Drive tools

See all 12 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.