v2

latestOpenAPI 3.1.02026-08-075421692.0 MB
Messages

Search conversations

Search your conversations two ways at once, and get back the matching conversations, most-recent match first:

  • Message text: matches words inside message bodies. Case-insensitive and accent-insensitive, exact tokens only (no substrings, no stemming). Each hit carries up to 3 most-recent matching messages. With direction=outgoing you can collect examples of how you write to customers, for example to teach an AI agent your tone of voice.
  • Contact identity: matches the participant's name, username, or phone number as a case-insensitive substring. These hits have matchCount 0 and an empty matches array.

A conversation that matches both ways is returned once, carrying its message matches.

Only platforms whose messages are stored by Zernio are searchable: WhatsApp, SMS, Telegram, Facebook, Instagram, Twitter/X and Reddit. Bluesky conversations are fetched live from the platform and cannot be searched; those accounts are listed in meta.accountsSkipped.

get/v1/inbox/conversations/search

Query parameters

querystring required

Text to search for, in message content and in the contact's name, username, or phone number

direction'incoming' | 'outgoing'

Only match messages sent to you (incoming) or by you (outgoing). Contact-identity matching is not applied when this is set.

profileIdstring

Filter by profile ID

platform'facebook' | 'instagram' | 'telegram' | 'whatsapp' | 'sms' | 'slack'

Filter by platform (searchable platforms only)

accountIdstring

Filter by specific social account ID

limitinteger

Maximum number of conversations to return

cursorstring

Pagination cursor for next page

Response

Conversations containing the query, most recent match first