---
title: "List my WhatsApp groups"
method: POST
path: "/api/v1/tools/list_groups"
---

# List my WhatsApp groups

`POST /api/v1/tools/list_groups`

## Request

- Base URL: `https://whatsync.app`
- URL: `https://whatsync.app/api/v1/tools/list_groups`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

List the groups the user's linked WhatsApp account is in, with each group's name and ID. Use the ID with get_group or the other group tools. Returns one page at a time.

## Headers

- `Idempotency-Key` string

## Request body

- object
  - `after` string
  - `limit` 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)
