Search WhatsApp messages

Search stored WhatsApp message text, attachment filenames, and contact names. Pass a known conversation_id as conversationId, and date filters when known. Searches default to 180 days and each requested date window is limited to 366 days.

post/api/v1/tools/search_messages

Request

  • Base URL: https://whatsync.app
  • URL: https://whatsync.app/api/v1/tools/search_messages
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Headers

Idempotency-Keystring

Stable key for a write; body idempotencyKey takes precedence.

Request body

querystring required

Words or phrase to search for

conversationIdstring

A conversation_id returned by another WhatSync tool, to limit the search to one conversation

direction'inbound' | 'outbound'

Limit matches by message direction

afterstring date-time

Search messages at or after this ISO timestamp

beforestring date-time

Search messages before this ISO timestamp

cursorstring

Opaque next_cursor returned by the previous page

limitinteger

Number of matches to return; defaults to 20

Response

JSON result. Every response includes X-Request-Id.

object required

Changes

No recorded changes to this operation across all 1 revision of this API.