Skip to main content
GET
List comments for a ticket
Deprecated: This is a v1 endpoint. It will continue to work, but we recommend migrating to the v2 equivalent for improved REST compliance (correct HTTP status codes, consistent response envelopes, and hyphenated URLs).
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 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

Page of results to retrieve, starting from 1. Defaults to 1 when omitted.

page_size
integer

Number of results per page. Defaults to 30 when omitted.

Response

200 - application/json

OK - Request succeeded

comments
object[]
pagination
object