List WhatsApp contacts

Find people in the user's own WhatsApp by name or number: people they have chatted with, plus contact names their linked WhatsApp shares. Only chats the user allowed WhatSync to save are included; numbers they excluded never appear. after/before limit chat history only. total_count gives how many people match. Use next_offset to page.

post/api/v1/tools/list_contacts

Request

  • Base URL: https://whatsync.app
  • URL: https://whatsync.app/api/v1/tools/list_contacts
  • 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
afterstring date-time
beforestring date-time
limitinteger
offsetinteger

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.