Skip to content

Get Comments

Endpoint

http
GET /unified/ticketing/comments/{id}
Integrations supported
  • Airtable
  • Asana
  • Basecamp
  • Bitbucket
  • Gorgias
  • HubSpot
  • Jira
  • Monday.com
  • Shortcut
  • 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. Defaults to `unified`. `unified` will return the response with unified mappings applied. `raw` will return the raw response from the remote API. `normalized` will apply the unified mappings and return the data in a normalized format.
All possible enum values:
  • unified
  • raw
  • normalized
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.
Example: remote_query[foo]=bar
ticket_id
string
The unique identifier for a ticket
Required in
  • Airtable
  • HubSpot
  • Jira
  • Zoho Desk
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
is_internal
boolean
Whether the comment is internal. True for internal notes left by users.
Supported in
  • Zoho Desk
ticket
object
The unique identifier for a ticket
Required in
  • Bitbucket
  • Shortcut
id
string
REQUIRED · The unique identifier for a ticket
workspace
object
The unique identifier for a workspace
Required in
  • Bitbucket
collections
array
The unique identifier for a ticket
Required in
  • Bitbucket

Response Body

id
string
REQUIRED · The unique identifier for a comment
Supported in
  • Airtable
  • Asana
  • Basecamp
  • Bitbucket
  • Gorgias
  • HubSpot
  • Jira
  • Monday.com
  • Shortcut
  • Zoho Desk
author
object
The id of the user or contact who created the comment
Supported in
  • Airtable
  • Asana
  • Basecamp
  • Bitbucket
  • Gorgias
  • HubSpot
  • Jira
  • Monday.com
  • Shortcut
  • 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
type
string
REQUIRED · Type of the author
All possible enum values:
  • user
  • contact
  • system
body
string
The body of the comment
Supported in
  • Airtable
  • Asana
  • Basecamp
  • Bitbucket
  • Gorgias
  • HubSpot
  • Jira
  • Monday.com
  • Shortcut
  • Zoho Desk
html_body
string
The body of the comment in HTML format
Supported in
  • Asana
  • Bitbucket
  • Gorgias
  • HubSpot
  • Jira
  • Monday.com
  • Zoho Desk
ticket
object
The ticket to which the comment belongs
Supported in
  • Airtable
  • Asana
  • Basecamp
  • Bitbucket
  • Gorgias
  • HubSpot
  • Jira
  • Monday.com
  • Shortcut
  • Zoho Desk
id
string
REQUIRED · The unique identifier for a ticket
attachments
object[]
The attachments of the comment
Supported in
  • HubSpot
  • Monday.com
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
  • Zoho Desk
is_private
boolean
Whether the comment is private or not
Supported in
  • Basecamp
  • Gorgias
  • Zoho Desk
created_at
string · date-time
The date and time when the comment was created
Supported in
  • Airtable
  • Asana
  • Basecamp
  • Bitbucket
  • Gorgias
  • HubSpot
  • Jira
  • Monday.com
  • Shortcut
  • Zoho Desk
updated_at
string · date-time
The date and time when the comment was updated
Supported in
  • Airtable
  • Asana
  • Basecamp
  • Bitbucket
  • Jira
  • Monday.com
  • Shortcut
  • Zoho Desk
remote_data
object
Raw data returned from the remote API call.