v5

latestOpenAPI 3.0.02026-08-04258282491.7 KB
Messages

Find messages by query

Get messages by query with support for filtering and pagination.

Filtering:

  • Filter by ticket: ticket=507f1f77bcf86cd799439011
  • Filter by type: type=TEXT or type=TEXT,NOTE (comma-separated values match any; bracket syntax such as type[$in]=... is NOT supported)
  • Filter by bot messages: bot=true or bot=false
  • Filter by date range: createdAt>=2024-01-01&createdAt<=2024-12-31

Ordering: Messages are always returned oldest-first (ascending createdAt); the sort order is not configurable.

Pagination:

  • Cursor mode (recommended): pass paginated=true to receive { items, hasMore, nextBefore }; pass before=<messageId> (the previous nextBefore) to fetch the next older page. skip is ignored in this mode; limit defaults to 30 and is clamped to 1-100.
  • Legacy mode (no paginated): returns a flat array; limit defaults to 1000 and values above 100 are clamped to 100; skip is applied. Pass showHistory=false to hide ticket-history entries.

Translation:

  • language=es returns messages translated into the given language. Requires the project setting 'translate customer messages'; only conversation messages (TEXT, USER_TEXT, NOTE, BOT, BOT_REPLY, SHARED_COMMENT) are translated, and messages already in the target language are returned unchanged.
get/messages

Query parameters

paginatedboolean
  • Set to true for cursor mode: returns { items, hasMore, nextBefore }
beforestring
  • Cursor for the next older page (the previous response's nextBefore); only with paginated=true
limitnumber double
  • Maximum number of messages to return. Cursor mode: default 30, clamped to 1-100. Legacy mode: default 1000, values above 100 are clamped to 100.
showHistoryboolean
  • Set to false to hide ticket-history entries

Headers

projectstring required

Response

Ok

OR