Skip to main content
GET
List or fetch WhatsApp messages

Authorizations

Authorization
string
header
required

HTTP Basic where username is your account e-mail and password is your security token.

Query Parameters

message_id
integer

When set, returns a single detailed message instead of the list (with presigned media URLs, including those of recipient replies).

status
enum<string>

Filter the outbox by status. Any value outside the enum is rejected with 400.

Available options:
pending,
processing,
sent,
delivered,
read,
failed,
cancelled
date_from
string<date>

List only messages created on or after this day (YYYY-MM-DD, Brasília time). A malformed date is rejected with 400.

date_to
string<date>

List only messages created on or before this day (YYYY-MM-DD, Brasília time, inclusive). A malformed date is rejected with 400.

recipient
string

Part of the recipient name, or at least 4 digits of the recipient phone.

tag
string

Exact tag of the message.

limit
integer
default:50

Items per page, 1-100. A non-numeric value is rejected with 400.

Required range: 1 <= x <= 100
offset
integer
default:0

Response

Messages

Standard envelope used by the WhatsApp message and sender endpoints (same shape as the letters and e-mail envelopes).

status
integer
Example:

200

status_message
string
data
List mode · object