Appearance

List Comments ​

Endpoint ​

http
GET /unified/ticketing/comments
Integrations supported
  • Airtable
  • Asana
  • Azure DevOps
  • Basecamp
  • ClickUp
  • Freshdesk
  • Gorgias
  • Help Scout
  • Intercom
  • Jira
  • Linear
  • Trello
  • Zendesk
  • Zoho Desk
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 ​

integrated_account_id
string · uuid
REQUIRED · The ID of the integrated account to use for the request.
Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
ticket_id
string
The unique identifier for a ticket
Required in
  • Airtable
  • Asana
  • Azure DevOps
  • Basecamp
  • ClickUp
  • Freshdesk
  • Gorgias
  • Help Scout
  • Intercom
  • Jira
  • Linear
  • Trello
  • Zendesk
  • Zoho Desk
team_id
string
The unique identifier for the team.
Supported in
  • ClickUp
created_at
string
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

Response Body ​

result
object[]
List of Comments
id
string
REQUIRED · The unique identifier for a comment
Supported in
  • Airtable
  • Asana
  • Azure DevOps
  • Basecamp
  • ClickUp
  • Freshdesk
  • Gorgias
  • Help Scout
  • Intercom
  • Jira
  • Linear
  • Trello
  • Zendesk
  • Zoho Desk
author
object
The id of the user or contact who created the comment
Supported in
  • Airtable
  • Asana
  • Azure DevOps
  • Basecamp
  • ClickUp
  • Freshdesk
  • Gorgias
  • Help Scout
  • Intercom
  • Jira
  • Linear
  • Trello
  • Zendesk
  • Zoho Desk
id
string
REQUIRED · The id of the user or contact who created the comment
type
string
REQUIRED · Type of the author
All possible enum values:
  • user
  • contact
body
string
The body of the comment
Supported in
  • Airtable
  • Asana
  • Azure DevOps
  • Basecamp
  • ClickUp
  • Freshdesk
  • Gorgias
  • Help Scout
  • Jira
  • Linear
  • Trello
  • Zendesk
  • Zoho Desk
html_body
string
The body of the comment in HTML format
Supported in
  • Asana
  • Freshdesk
  • Gorgias
  • Help Scout
  • Intercom
  • Jira
  • Zendesk
  • Zoho Desk
ticket
object
The ticket to which the comment belongs
Supported in
  • Airtable
  • Asana
  • Azure DevOps
  • Basecamp
  • ClickUp
  • Freshdesk
  • Gorgias
  • Help Scout
  • Intercom
  • Jira
  • Linear
  • Trello
  • Zendesk
  • Zoho Desk
id
string
REQUIRED · The unique identifier for a ticket
attachments
object[]
The attachments of the comment
Supported in
  • Zendesk
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
string
The user who uploaded the attachment
uploaded_by_type
string
The type of the user who uploaded the attachment
created_at
string
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
  • Freshdesk
  • Gorgias
  • Help Scout
  • Zendesk
  • Zoho Desk
created_at
string
The date and time when the comment was created
Supported in
  • Airtable
  • Asana
  • Azure DevOps
  • Basecamp
  • ClickUp
  • Freshdesk
  • Gorgias
  • Help Scout
  • Intercom
  • Jira
  • Linear
  • Trello
  • Zendesk
  • Zoho Desk
updated_at
string
The date and time when the comment was updated
Supported in
  • Airtable
  • Asana
  • Azure DevOps
  • Basecamp
  • Freshdesk
  • Intercom
  • Jira
  • Linear
  • Zoho Desk
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.