v1

latestOpenAPI 3.0.02026-08-061770538.1 KB

Ticket

Returns a paginated flat list of comments across multiple tickets

Required permissions: "Tickets - View Details" or "Tickets - View 'Their Ticket' Details (assigned to them)"

Returns a flat, paginated list of comments across multiple tickets sorted by ticket_id ASC, created_at DESC. All comments for a given ticket are adjacent in the response, with the newest comments first within each ticket.

Comments can be scoped to specific tickets using a saved Ticket View (ticket_search_id) and/or direct ticket filters such as customer_id, status, etc.

Comment-level date filters use the comment_ prefix to distinguish them from the ticket-level date filters that share similar names (e.g. created_after).

Single-Customer Users can only access comments for their own tickets.

get/ticket_comments

Query parameters

ticket_search_idinteger

Scope results to tickets matching this saved Ticket View (Ticket Search) ID

ticket_idinteger

Scope results to a specific ticket

customer_idinteger

Scope results to tickets belonging to this customer

contact_idinteger

Scope results to tickets belonging to this contact

user_idinteger

Scope results to tickets assigned to this user

statusstring

Scope results to tickets with this status. Use 'Not Closed' to exclude resolved tickets.

resolved_afterstring

Scope results to tickets resolved after this date

created_afterstring

Scope results to tickets created after this date

since_updated_atstring

Scope results to tickets updated after this date

mineboolean

When true, scope results to tickets assigned to the authenticated user

comment_created_afterstring

Filter comments created after this date

comment_created_beforestring

Filter comments created before this date

pageinteger

Page of results to return. Default is 1.

per_pageinteger

Number of comments per page. Default is 25, maximum is 100.

comment_formatstring

Body format for comments. Allowed values: 'plaintext' (default), 'richtext', 'original'.

Response

successful