Appearance

List Comments ​

Endpoint ​

http
GET /unified/ticketing/comments
Integrations supported
  • Accelo
  • Airtable
  • Asana
  • Azure DevOps
  • Basecamp
  • Bitbucket
  • ClickUp
  • Dixa
  • Enchant
  • Freshdesk
  • GitLab
  • Gladly
  • Gorgias
  • Help Scout
  • Hive
  • HubSpot
  • Intercom
  • Jira
  • Linear
  • LiveChat
  • Monday.com
  • Pivotal Tracker
  • Quickbase for Project Management
  • Shortcut
  • Teamwork Project Management
  • Todoist
  • Trello
  • Wrike
  • YouTrack
  • Zendesk
  • Zoho Desk
  • Zoho Projects
Partial response integrations

For partial response integrations, you will need to fetch the individual resource using the "get" endpoint to get the full response object.

  • Zoho Desk

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 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.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_key_by
string

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limit
boolean

Ignores the limit query parameter.

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
ticket
object

The ticket to which the comment belongs

Integration specific notes
  • BitbucketThe unique identifier for a ticket
  • Pivotal TrackerSet either ticket or collections.
  • TodoistEither ticket or collections is required.
Required in
  • Accelo
  • Bitbucket
  • Dixa
  • Enchant
  • Freshdesk
  • GitLab
  • Gladly
  • Hive
  • LiveChat
  • Shortcut
  • Teamwork Project Management
  • Wrike
  • Zendesk
  • Zoho Projects
Supported in
  • Monday.com
  • Pivotal Tracker
  • Todoist
  • YouTrack
id
string
REQUIRED · 

The unique identifier for a ticket

conversations
array

The conversation to retrieve the comments for.

Required in
  • HubSpot
ticket_id
string

The unique identifier for a ticket

Required in
  • Airtable
  • Asana
  • Azure DevOps
  • Basecamp
  • ClickUp
  • Gorgias
  • Help Scout
  • Intercom
  • Jira
  • Linear
  • Trello
  • Zoho Desk
sort_by
object

The field to sort the resource by. Should be in format { fieldName: direction }. The direction can be asc or desc.

All possible enum values:
  • created_at
  • updated_at
Supported in
  • Gorgias
  • Zoho Projects
created_at
string · date-time

The date and time when the comment was created

All possible enum values:
  • asc
  • desc
Supported in
  • Gorgias
team_id
string

The unique identifier for the team.

Supported in
  • ClickUp
created_at
string · date-time

The date and time when the comment was created

Supported in
  • ClickUp
  • Jira
workspace_id
string

The unique identifier for a workspace

Required in
  • Airtable
  • Azure DevOps
  • Basecamp
collection_id
string

The unique identifier for a collection

Required in
  • Airtable
workspace
object

The unique identifier for a workspace

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

The unique identifier for a collection.

updated_at
string · date-time

The date and time when the comment was updated

Supported in
  • Teamwork Project Management
  • Zoho Projects
organization
object
Supported in
  • Zoho Projects
id
string

The unique identifier for a organization.

ticket_type
All possible enum values:
  • issue
  • task
Required in
  • Zoho Projects

Response Body ​

result
object[]

List of Comments

id
string
REQUIRED · 

The unique identifier for a comment

Supported in
  • Accelo
  • Airtable
  • Asana
  • Azure DevOps
  • Basecamp
  • Bitbucket
  • ClickUp
  • Dixa
  • Enchant
  • Freshdesk
  • GitLab
  • Gladly
  • Gorgias
  • Help Scout
  • Hive
  • HubSpot
  • Intercom
  • Jira
  • Linear
  • LiveChat
  • Monday.com
  • Pivotal Tracker
  • Quickbase for Project Management
  • Shortcut
  • Teamwork Project Management
  • Todoist
  • Trello
  • Wrike
  • YouTrack
  • Zendesk
  • Zoho Desk
  • Zoho Projects
author
object

The id of the user or contact who created the comment

Supported in
  • Accelo
  • Airtable
  • Asana
  • Azure DevOps
  • Basecamp
  • Bitbucket
  • ClickUp
  • Dixa
  • Enchant
  • Freshdesk
  • GitLab
  • Gladly
  • Gorgias
  • Help Scout
  • Hive
  • HubSpot
  • Intercom
  • Jira
  • Linear
  • LiveChat
  • Monday.com
  • Pivotal Tracker
  • Shortcut
  • Teamwork Project Management
  • Trello
  • Wrike
  • YouTrack
  • Zendesk
  • Zoho Desk
  • Zoho Projects
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
receiver
object

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

Supported in
  • Gorgias
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
  • Azure DevOps
  • Basecamp
  • Bitbucket
  • ClickUp
  • Dixa
  • Enchant
  • Freshdesk
  • GitLab
  • Gladly
  • Gorgias
  • Help Scout
  • HubSpot
  • Jira
  • Linear
  • LiveChat
  • Monday.com
  • Pivotal Tracker
  • Shortcut
  • Teamwork Project Management
  • Todoist
  • Trello
  • Wrike
  • YouTrack
  • Zendesk
  • Zoho Desk
  • Zoho Projects
html_body
string

The body of the comment in HTML format

Supported in
  • Accelo
  • Asana
  • Bitbucket
  • Dixa
  • Enchant
  • Freshdesk
  • Gladly
  • Gorgias
  • Help Scout
  • Hive
  • HubSpot
  • Intercom
  • Jira
  • Monday.com
  • Teamwork Project Management
  • Zendesk
  • Zoho Desk
ticket
object

The ticket to which the comment belongs

Supported in
  • Accelo
  • Airtable
  • Asana
  • Azure DevOps
  • Basecamp
  • Bitbucket
  • ClickUp
  • Dixa
  • Enchant
  • Freshdesk
  • GitLab
  • Gladly
  • Gorgias
  • Help Scout
  • Hive
  • Intercom
  • Jira
  • Linear
  • LiveChat
  • Monday.com
  • Pivotal Tracker
  • Shortcut
  • Todoist
  • Trello
  • Wrike
  • YouTrack
  • Zendesk
  • Zoho Desk
  • Zoho Projects
id
string
REQUIRED · 

The unique identifier for a ticket

attachments
object[]

The attachments of the comment

Supported in
  • Accelo
  • Enchant
  • Freshdesk
  • Gorgias
  • Help Scout
  • Hive
  • HubSpot
  • Intercom
  • LiveChat
  • Monday.com
  • Todoist
  • Wrike
  • YouTrack
  • Zendesk
  • Zoho Projects
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
  • Enchant
  • GitLab
  • Gladly
  • Gorgias
  • HubSpot
  • Zoho Desk
is_private
boolean

Whether the comment is private or not

Supported in
  • Basecamp
  • Freshdesk
  • GitLab
  • Gorgias
  • Help Scout
  • HubSpot
  • Intercom
  • LiveChat
  • Teamwork Project Management
  • Zendesk
  • Zoho Desk
channel
object

The medium through which the comment was sent.

Supported in
  • Gladly
  • Gorgias
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
  • Azure DevOps
  • Basecamp
  • Bitbucket
  • ClickUp
  • Dixa
  • Enchant
  • Freshdesk
  • GitLab
  • Gladly
  • Gorgias
  • Help Scout
  • Hive
  • HubSpot
  • Intercom
  • Jira
  • Linear
  • LiveChat
  • Monday.com
  • Pivotal Tracker
  • Shortcut
  • Teamwork Project Management
  • Todoist
  • Trello
  • Wrike
  • YouTrack
  • Zendesk
  • Zoho Desk
  • Zoho Projects
updated_at
string · date-time

The date and time when the comment was updated

Supported in
  • Accelo
  • Airtable
  • Asana
  • Azure DevOps
  • Basecamp
  • Bitbucket
  • Freshdesk
  • GitLab
  • Intercom
  • Jira
  • Linear
  • Monday.com
  • Pivotal Tracker
  • Shortcut
  • Teamwork Project Management
  • Wrike
  • YouTrack
  • Zoho Desk
  • Zoho Projects
etag
string

The unique identifier for the specific version of the resource.

remote_data
object

Raw data returned from the remote API call.

next_cursor
string

The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.