List WhatsApp conversations

List recent WhatsApp conversations available to the connected WhatSync account. Optionally filter by contact name, phone number, conversation identifier, or date window. Results are paginated and never include excluded numbers.

post/api/v1/tools/list_conversations

Request

  • Base URL: https://whatsync.app
  • URL: https://whatsync.app/api/v1/tools/list_conversations
  • 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

Optional contact name, phone number, or conversation identifier

afterstring date-time

List conversations active at or after this ISO timestamp; defaults to the 180 days ending at before

beforestring date-time

Return conversations active before this ISO timestamp

cursorstring

Opaque next_cursor returned by the previous page

limitinteger

Number of conversations 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.