The comment search API lets you find, filter, and analyze comments or notes attached to tickets or other entities using flexible Typesense-powered queries. You can search by text, filter by any comment property, and select exactly which fields you want in the response.
Note: Fallback search mode is not supported for comments. Only primary search mode is available.
Get all comments for a specific ticket
Find comments created by a specific user
List all pinned comments in the last 7 days
Get comments containing the word ‘urgent’
Find edited comments for a specific team
Below are all the fields you may see in a comment search result. Many are optional and will only appear if included in your include_fields
parameter.
Field | Type | Description |
---|---|---|
ticket_id | string | Ticket ID the comment belongs to |
content | string | Comment content |
created_at | string | Creation timestamp (ISO8601) |
updated_at | string | Last update timestamp (ISO8601) |
created_by_id | string | Creator’s user ID |
created_by_email | string | Creator’s email |
created_by_name | string | Creator’s name |
team_uid | string | Team UID |
team_identifier | string | Team identifier |
ticket_ticket_id | string | Ticket’s ticket ID |
comment_type | string | Type of comment |
comment_visibility | string | Comment visibility |
is_edited | boolean | Whether the comment was edited |
is_pinned | boolean | Whether the comment is pinned |
content_markdown | string | Markdown content |
content_html | string | HTML content |
organization_id | string | Organization ID |
ticket_identifier | string | Ticket identifier |
ticket_uid | string | Ticket UID |
organization_uid | string | Organization UID |
For a full list, see the CommentSearchResponseDto in the API reference.
Tip: Use the include_fields
parameter to limit the response to only the fields you need for performance and clarity.
document
in each hit will match the schema for the selected collection (Ticket, Account, or Comment).For more details on available fields and advanced search options, refer to the Typesense documentation or your collection’s schema.