---
title: "List WhatsApp contacts"
method: POST
path: "/api/v1/tools/list_contacts"
---

# List WhatsApp contacts

`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`

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.

## Headers

- `Idempotency-Key` string

## Request body

- object
  - `query` string
  - `after` string, date-time
  - `before` string, date-time
  - `limit` integer
  - `offset` integer

## Response `200`

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

- object

## Other responses

- `400`: API error
- `401`: API error
- `403`: API error
- `404`: API error
- `409`: API error
- `413`: API error
- `415`: API error
- `422`: API error
- `429`: API error
- `503`: API error

---

[API](https://skmtc.dev/whatsync/apis/whatsync-api.md) · [All operations](https://skmtc.dev/whatsync/apis/whatsync-api/llms.txt) · [OpenAPI document](https://skmtc.dev/whatsync/apis/whatsync-api/revisions/6fa5498b63b7?raw)