List WhatsApp messages

Retrieves a list of WhatsApp messages for your account with flexible date filtering.

Messages are returned in reverse chronological order (newest first).

Date Filtering:

  • Preset ranges (last_week, last_thirty, last_month): Calculated using your account timezone
  • Custom date ranges: Use RFC3339 timestamps (max 90 days)
  • The 'all' option provides up to 365 days of history
  • All timestamps in responses are returned in UTC format

Pagination:

  • Cursor-based pagination for efficient data retrieval
  • Control page size with the limit parameter (1-100 messages per page)
Query Params
string
enum
Defaults to all

Predefined date range filter. Preset ranges use your account timezone to calculate relative dates:

  • 'last_week': Last 7 days from midnight in your account timezone
  • 'last_thirty': Last 30 days from midnight in your account timezone
  • 'last_month': Previous calendar month in your account timezone
  • 'all': All dates (limited to last 365 days) - default
  • 'custom_date': Use start_date and end_date parameters with explicit RFC3339 timestamps
Allowed:
string

Start date for custom date range in RFC3339 format (e.g., 2025-08-26T10:30:00Z). Required when date_range is 'custom_date'. Must be before end_date.

string

End date for custom date range in RFC3339 format (e.g., 2025-08-26T23:59:59Z). Required when date_range is 'custom_date'. Must be after start_date. The range between start_date and end_date cannot exceed 90 days.

int32
1 to 100
Defaults to 25

Maximum number of messages to return per page (1-100, default 25).

string

Pagination cursor returned from a previous request. Pass the next_cursor or prev_cursor value from a previous response to fetch the next or previous page of results. Omit for the first page.

string
enum
Defaults to next

Pagination direction when using a cursor:

  • 'next': Get older messages (default, moves forward through history)
  • 'prev': Get newer messages (moves backward through history)
Allowed:
Responses

Language
Credentials
Header
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json