v3

latestOpenAPI 3.0.02026-07-31800117.7 KB
Capabilities

activity.search

Search past source activity logs across email, WhatsApp, uploads, and forwarded inbound email. For email sources, this first searches connected providers, then cross-checks matching message IDs against stored activity logs and returns any saved processing reasoning. Forwarded inbound email is matched directly against stored activity by its alias address.

post/capabilities/activity.search

Request body

querystring required

Natural-language or exact search query such as merchant, sender, or invoice keyword.

sourceTypesstring[]

Which source activity types to search.

statusesstring[]

Optional activity statuses to include.

pageinteger

Page number for paginated results.

limitinteger

Maximum number of activity items to return.

includeSourceDetailsboolean

Whether to reload matching provider messages for richer email details like subject, sender, and snippet.

providerResultLimitinteger

Maximum number of provider search matches to cross-check before filtering activity logs.

Response

Successful response

successboolean
codeinteger

Example response

{
  "success": true,
  "code": 200
}