Appearance

Get Comments ​

Endpoint ​

http
GET /unified/file-storage/comments/{id}
Integrations supported
  • Google
  • Google Drive

Path parameters ​

id
string
REQUIRED · 

The ID of the resource.

Example: 23423523

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.
  • debug returns the final unified result alongside raw remote fetch information. The response is an envelope containing result (identical to unified mode output) and debug (with requestUrl, requestOptions, data, responseHeaders, and for list operations: nextCursor, isLooping, isEmptyResult, resultCount). debug is null for static responses or when truto_skip_api_call=true.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
  • debug
Example: unified
truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
drive_item
string

The unique identifier of the drive item the comment belongs to

Required in
  • Google
  • Google Drive
id
string

The unique identifier for a drive item

name
string

The name of the drive item

type
string

The type of the drive item

All possible enum values:
  • file
  • folder
include_deleted
boolean

Whether to allow retrieving a deleted comment

Supported in
  • Google
  • Google Drive

Response Body ​

id
string
REQUIRED · 

The unique identifier for a comment

Supported in
  • Google
  • Google Drive
drive_item
object

The drive item the comment is associated with

Supported in
  • Google
  • Google Drive
id
string

The unique identifier for a drive item

name
string

The name of the drive item

type
string

The type of the drive item

All possible enum values:
  • file
  • folder
parent
object

The parent comment this comment is replying to

id
string

The unique identifier for a comment

body
object

The body of the comment

Supported in
  • Google
  • Google Drive
content
string

The content of the comment body

type
string

The type of content in the comment body

All possible enum values:
  • html
  • plaintext
anchor
object

The location or context within the drive item that the comment is associated with

Supported in
  • Google
  • Google Drive
description
string

The description of the anchor

position
string

The position or range in the drive item

version
object

The drive item version the anchor applies to

id
string

The unique identifier for a version

author
object

The author of the comment

Supported in
  • Google
  • Google Drive
id
string

The unique identifier for a user

name
string

The name of the user

emails
object[]

The emails of the user

email
string

The email address

type
string

The type of email address

is_primary
boolean

Whether the email address is primary

mentions
object[]

The users mentioned in the comment

Supported in
  • Google
  • Google Drive
id
string

The unique identifier for a user

name
string

The name of the user

emails
object[]

The emails of the user

email
string

The email address

type
string

The type of email address

is_primary
boolean

Whether the email address is primary

status
string

The status of the comment

Supported in
  • Google
  • Google Drive
created_at
string · date-time

The date and time the comment was created

Supported in
  • Google
  • Google Drive
updated_at
string · date-time

The date and time the comment was last updated

Supported in
  • Google
  • Google Drive
remote_data
object

Raw data returned from the remote API call.