v4

OpenAPI 3.0.0MIT2026-07-311494532.1 MB
Messages

List all messages

List all messages for the current environment. This API supports filtering by channel, subscriberId, and transactionId. This API returns a paginated list of messages.

get/v1/messages

Query parameters

channel'in_app' | 'email' | 'sms' | 'chat' | 'push' | 'tool'

Channel type through which the message is sent

subscriberIdstring
transactionIdstring[]
contextKeysstring[]

Filter by exact context keys, order insensitive (format: "type:id")

pagenumber
limitnumber

Headers

idempotency-keystring

A header for idempotency purposes

Response

totalCountnumber

Total number of messages available

hasMoreboolean required

Indicates if there are more messages available

pageSizenumber required

Number of messages per page

pagenumber required

Current page number