Skip to main content
POST
Search Ticket Messages

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
teamIds
string[]

Optional. Filter to messages on tickets in these teams. If not provided, searches all teams the caller can view tickets in.

ticketIds
string[]

Optional. Only return messages on any of these tickets. This is the batch alternative to calling List Ticket Messages per ticket.

authorUserIds
string[]

Optional. Only return messages authored by any of these users. Assistant and system messages have no author user and never match.

authorRoles
enum<string>[]

Optional. Filter by author roles. Returns messages matching ANY of the specified roles (e.g. USER_ROLE for human messages, INTERNAL_NOTE_ROLE for internal notes).

Available options:
USER_ROLE,
ASSISTANT_ROLE,
SYSTEM_INFO_ROLE,
INTERNAL_NOTE_ROLE
createdAfter
string<date-time> | null

A timestamp in RFC 3339 format (e.g., "2025-01-15T01:30:15Z").

Example:

"2025-01-15T01:30:15.000Z"

createdBefore
string<date-time> | null

A timestamp in RFC 3339 format (e.g., "2025-01-15T01:30:15Z").

Example:

"2025-01-15T01:30:15.000Z"

pageSize
integer<int32> | null

Maximum number of results to return. Default is 100, maximum is 1000.

pageToken
string | null

Token for pagination. Leave empty for the first request.

Response

200 - application/json

Success

data
Message · object[]
nextPageToken
string | null

Token for retrieving the next page of results. Empty if no more results.