Appearance

Get Comments ​

Endpoint ​

http
GET /unified/ticketing/comments/{id}
Integrations supported
  • Accelo
  • Airtable
  • Asana
  • Basecamp
  • Bitbucket
  • BMC Helix
  • eDesk
  • Front
  • Gorgias
  • HubSpot
  • Jira
  • Jira Service Management
  • Kustomer
  • Monday.com
  • Pivotal Tracker
  • Quickbase for Project Management
  • ServiceNow
  • Shortcut
  • Todoist
  • Trengo
  • Wrike
  • Zoho Desk

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.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
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
workspace_id
string

The unique identifier for a workspace

Required in
  • Airtable
  • Basecamp
collection_id
string

The unique identifier for a collection

Required in
  • Airtable
ticket_id
string

The unique identifier for a ticket

Required in
  • Airtable
  • Zoho Desk
ticket
string

The ticket to which the comment belongs

Integration specific notes
  • BitbucketThe unique identifier for a ticket
  • Pivotal TrackerSet either ticket or collections.
  • TrengoThe unique identifier for a ticket
Required in
  • Bitbucket
  • Jira
  • Jira Service Management
  • Shortcut
  • Trengo
Supported in
  • Pivotal Tracker
id
string
REQUIRED · 

The unique identifier for a ticket

workspace
object

The unique identifier for a workspace

Required in
  • Bitbucket
collections
array
Integration specific notes
  • BitbucketThe unique identifier for a ticket
  • Pivotal TrackerCollection with type epic is required.
Required in
  • Bitbucket
Supported in
  • Pivotal Tracker
id
string

The unique identifier for a collection.

is_internal
boolean

Whether the comment is internal. True for internal notes left by users.

Integration specific notes
  • FrontSet this value as true to get internal comments.
  • KustomerSet this value as true if the comment is internal.
All possible enum values:
  • true
Supported in
  • Front
  • Kustomer
  • Zoho Desk
conversations
array

The conversation to retrieve the comments for.

Required in
  • HubSpot

Response Body ​

id
string
REQUIRED · 

The unique identifier for a comment

Supported in
  • Accelo
  • Airtable
  • Asana
  • Basecamp
  • Bitbucket
  • BMC Helix
  • eDesk
  • Front
  • Gorgias
  • HubSpot
  • Jira
  • Jira Service Management
  • Kustomer
  • Monday.com
  • Pivotal Tracker
  • Quickbase for Project Management
  • ServiceNow
  • Shortcut
  • Todoist
  • Trengo
  • Wrike
  • Zoho Desk
author
object

The id of the user or contact who created the comment

Supported in
  • Accelo
  • Airtable
  • Asana
  • Basecamp
  • Bitbucket
  • BMC Helix
  • eDesk
  • Front
  • Gorgias
  • HubSpot
  • Jira
  • Jira Service Management
  • Kustomer
  • Monday.com
  • Pivotal Tracker
  • ServiceNow
  • Shortcut
  • Trengo
  • Wrike
  • Zoho Desk
id
string
REQUIRED · 

The id of the user or contact who created the comment

name
string

The name of the user or contact who created the comment

username
string

The username of the user or contact who created the comment

type
string
REQUIRED · 

Type of the author

All possible enum values:
  • user
  • contact
  • system
receiver
object

The id of the user or contact who is receiving the comment

Supported in
  • Front
  • Gorgias
  • Trengo
id
string
REQUIRED · 

The id of the user or contact who receiving the comment

name
string

The name of the user or contact who receiving the comment

type
string
REQUIRED · 

Type of the receiver

All possible enum values:
  • user
  • contact
  • system
body
string

The body of the comment

Supported in
  • Accelo
  • Airtable
  • Asana
  • Basecamp
  • Bitbucket
  • BMC Helix
  • Front
  • Gorgias
  • HubSpot
  • Jira
  • Jira Service Management
  • Kustomer
  • Monday.com
  • Pivotal Tracker
  • ServiceNow
  • Shortcut
  • Todoist
  • Trengo
  • Wrike
  • Zoho Desk
html_body
string

The body of the comment in HTML format

Supported in
  • Accelo
  • Asana
  • Bitbucket
  • BMC Helix
  • eDesk
  • Front
  • Gorgias
  • HubSpot
  • Jira
  • Jira Service Management
  • Monday.com
  • Zoho Desk
ticket
object

The ticket to which the comment belongs

References: Tickets → id
Supported in
  • Accelo
  • Airtable
  • Asana
  • Basecamp
  • Bitbucket
  • BMC Helix
  • eDesk
  • Front
  • Gorgias
  • Jira
  • Jira Service Management
  • Kustomer
  • Monday.com
  • Pivotal Tracker
  • ServiceNow
  • Shortcut
  • Todoist
  • Trengo
  • Wrike
  • Zoho Desk
id
string
REQUIRED · 

The unique identifier for a ticket

attachments
object[]

The attachments of the comment

Supported in
  • Accelo
  • BMC Helix
  • eDesk
  • Front
  • Gorgias
  • HubSpot
  • Kustomer
  • Monday.com
  • Todoist
  • Trengo
  • Wrike
id
string

The unique identifier for the attachment

file_name
string

The attachment's name.

file_url
string

The URL to download the attachment

content_type
string

The content type of the attachment

uploaded_by
object

The user who uploaded the attachment

id
string

The user who uploaded the attachment

name
string

The user who uploaded the attachment

uploaded_by_type
string

The type of the user who uploaded the attachment

created_at
string · date-time

The time when the attachment was created

is_internal
boolean

Whether the comment is internal. True for internal notes left by users.

Supported in
  • BMC Helix
  • eDesk
  • Front
  • Gorgias
  • Kustomer
  • ServiceNow
  • Trengo
  • Zoho Desk
is_private
boolean

Whether the comment is private or not

Supported in
  • Basecamp
  • BMC Helix
  • eDesk
  • Front
  • Gorgias
  • Jira
  • ServiceNow
  • Zoho Desk
channel
object

The medium through which the comment was sent.

Supported in
  • BMC Helix
  • Gorgias
  • Kustomer
id
string

The unique identifier for the channel

name
string

The name of the channel

type
string

The type of the channel

created_at
string · date-time

The date and time when the comment was created

Supported in
  • Accelo
  • Airtable
  • Asana
  • Basecamp
  • Bitbucket
  • BMC Helix
  • eDesk
  • Front
  • Gorgias
  • HubSpot
  • Jira
  • Jira Service Management
  • Kustomer
  • Monday.com
  • Pivotal Tracker
  • ServiceNow
  • Shortcut
  • Todoist
  • Trengo
  • Wrike
  • Zoho Desk
updated_at
string · date-time

The date and time when the comment was updated

Supported in
  • Accelo
  • Airtable
  • Asana
  • Basecamp
  • Bitbucket
  • BMC Helix
  • Front
  • Jira
  • Jira Service Management
  • Kustomer
  • Monday.com
  • Pivotal Tracker
  • Shortcut
  • Trengo
  • Wrike
  • Zoho Desk
etag
string

The unique identifier for the specific version of the resource.

remote_data
object

Raw data returned from the remote API call.