Skip to main content
GET
List messages

Authorizations

X-API-Key
string
header
required

Query Parameters

phone_number_id
string

Filter by WhatsApp phone number ID

conversation_id
string<uuid>

Filter by conversation ID

phone_number
string

Filter by contact phone number (partial match)

business_scoped_user_id
string

Filter by exact WhatsApp business-scoped user ID

direction
enum<string>

Filter by message direction

Available options:
inbound,
outbound
status
enum<string>

Filter by message status

Available options:
pending,
sent,
delivered,
read,
failed
message_type
string

Filter by message type

has_media
boolean

Filter messages with media attachments

limit
integer
default:20

Maximum number of results per cursor-paginated page (default 20, max 100).

Required range: 1 <= x <= 100
before
string

Cursor for the previous page (Base64 encoded).

after
string

Cursor for the next page (Base64 encoded).

Response

List of messages

data
object[]
required
paging
object
required