Skip to main content
GET
/
tickets
/
{ticket_id}
/
comments
List comments for a ticket
curl --request GET \
  --url https://{your-workspace}.neetodesk.com/api/v1/public/tickets/{ticket_id}/comments \
  --header 'X-Api-Key: <x-api-key>'
{
  "comments": [
    {
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "comment_type": "<string>",
      "content": "<string>",
      "author": {
        "id": "<string>",
        "name": "<string>",
        "email": "<string>",
        "type": "<string>"
      },
      "attachments": [
        {
          "id": "<string>",
          "url": "<string>",
          "file_name": "<string>"
        }
      ]
    }
  ],
  "pagination": {
    "total_records": 123,
    "total_pages": 123,
    "current_page_number": 123,
    "page_size": 123
  }
}
Replace {your-workspace} with your workspace’s subdomain.
Learn how to find your subdomain in Identifying your subdomain.

Headers

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

X-Api-Key is used to authenticate requests using an API key. Provide your API key in this header to access protected endpoints. Refer to Authentication for more information.

Path Parameters

​
ticket_id
string
required

ID of the ticket to retrieve comments for. 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.

Response

200 - application/json

OK - Request succeeded

​
comments
object[]
​
pagination
object
⌘I