Skip to main content
GET
List ticket messages

Authorizations

Authorization
string
header
required

API key from your account settings

Path Parameters

agentId
string
required

The agent ID

Minimum string length: 1
Example:

"5QHA6VB-DIAbBhxwqxfdi"

ticketNumber
integer
required

The ticket number

Required range: x <= 2147483647
Example:

123

Query Parameters

cursor
string

Opaque cursor from a previous response to fetch the next page

Example:

"eyJ0IjoiMjAyNC0wMS0xNVQxMDozMDowMC4wMDBaIiwiaWQiOiJhYmMxMjMifQ=="

limit
integer
default:20

Number of items per page (1 to 100, default 20)

Required range: 1 <= x <= 100
Example:

20

types
string
default:reply,note

Comma-separated message types. Defaults to reply,note; system event messages are opt-in.

Example:

"reply,note"

order
enum<string>
default:asc

Chronological direction. Defaults to asc, so a thread reads oldest-first. A cursor is only valid for the direction it was issued with.

Available options:
asc,
desc
Example:

"asc"

Response

Paginated list of messages

data
object[]
required
pagination
object
required