List comments

Retrieves all comments for a specific ticket.

GET /tickets/{ticket_id}/comments

List comments for a ticket

cURL

curl --request GET \
  --url https://{your-subdomain}.neetodesk.com/api/external/v2/tickets/{ticket_id}/comments \
  --header 'X-Api-Key: <x-api-key>'

200

{
  "comments": [
    {
      "id": "aaaabbbb-cccc-dddd-eeee-ffff00002222",
      "created_at": "2023-11-07T05:31:56Z",
      "comment_type": "reply",
      "content": "We are looking into the issue and will update you shortly.",
      "author": {
        "id": "aaaabbbb-cccc-dddd-eeee-ffff00001111",
        "name": "Oliver Smith",
        "email": "[e-mail]",
        "type": "user"
      },
      "attachments": [
        {
          "id": "aaaabbbb-cccc-dddd-eeee-ffff00003333",
          "url": "https://example.com/attachments/screenshot.png",
          "filename": "screenshot.png"
        }
      ],
      "mentions": [
        {
          "id": "aaaabbbb-cccc-dddd-eeee-ffff00005555",
          "name": "Daniel Kuhlman",
          "email": "[e-mail]"
        }
      ]
    }
  ],
  "pagination": {
    "total_records": 95,
    "total_pages": 4,
    "current_page_number": 1,
    "page_size": 30
  }
}

Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Workspace subdomain.

Headers

X-Api-Key · string · default: your-api-key · required

Use the X-Api-Key header to provide your workspace API key. Refer to Authentication for more information.

Path Parameters

ticket_id · string · required

ID of the ticket. You can use either the ticket ID (UUID) or ticket number (sequential number) interchangeably. Refer to Getting Ticket ID section for detailed instructions.

Query Parameters

page_number · integer

Retrieve paginated results by specifying the desired page number. If this parameter is absent, all results will be returned.

page_size · integer

Set the number of results returned in the response. Defaulting to 30 when omitted.

Response

200 - application/json

OK - Request succeeded

comments · object[]

Hide child attributes

comments. id · string

Example:

"aaaabbbb-cccc-dddd-eeee-ffff00002222"

comments. created_at · string<date-time>

comments. comment_type · string

Example:

"reply"

comments. content · string

Example:

"We are looking into the issue and will update you shortly."

comments. author · object

Hide child attributes

comments.author. id · string

Example:

"aaaabbbb-cccc-dddd-eeee-ffff00001111"

comments.author. name · string

Example:

"Oliver Smith"

comments.author. email · string

Example:

"[e-mail]"

comments.author. type · string

Example:

"user"

comments. attachments · object[]

Hide child attributes

comments.attachments. id · string

Example:

"aaaabbbb-cccc-dddd-eeee-ffff00003333"

comments.attachments. url · string

Example:

"https://example.com/attachments/screenshot.png"

comments.attachments. filename · string

Example:

"screenshot.png"

comments. mentions · object[]

Hide child attributes

comments.mentions. id · string

Example:

"aaaabbbb-cccc-dddd-eeee-ffff00005555"

comments.mentions. name · string

Example:

"Daniel Kuhlman"

comments.mentions. email · string<email>

Example:

"[e-mail]"

pagination · object

Hide child attributes

pagination. total_records · integer

Example:

95

pagination. total_pages · integer

Example:

4

pagination. current_page_number · integer

Example:

1

pagination. page_size · integer

Example:

30