---
title: "List groups"
method: GET
path: "/api/profiles/{profile_id}/whatsapp/groups"
tags: ["WhatsApp"]
---

# List groups

`GET /api/profiles/{profile_id}/whatsapp/groups`

## Request

- Base URL: `https://api.postproxy.dev`
- URL: `https://api.postproxy.dev/api/profiles/{profile_id}/whatsapp/groups`
- Auth: HTTP bearer

Lists the WhatsApp groups owned by the number. Meta gates the groups API by account eligibility and it is not available on coexistence numbers.

## Query parameters

- `profile_group_id` string
- `phone_number_id` string, required
- `limit` integer
- `after` string

## Response `200`

Groups.

- WhatsAppGroupListResponse
  - `groups` WhatsAppGroup[]
    - `id` string
    - `subject` string
    - `description` string
    - `join_approval_mode` 'approval_required' | 'auto_approve'
    - `invite_link` string
    - `participants` object[]
    - `participant_count` integer
    - `created_at` integer: Unix seconds
    - `is_suspended` boolean
  - `next_cursor` string, nullable

## Other responses

- `400`: Missing required parameters.
- `401`: Invalid, missing, or insufficient API key permissions.
- `404`: Resource does not exist or is not accessible.
- `422`: Validation failed.

---

[API](https://skmtc.dev/postproxy/apis/postproxy-social-media-api.md) - [All operations](https://skmtc.dev/postproxy/apis/postproxy-social-media-api/llms.txt) - [OpenAPI document](https://skmtc.dev/postproxy/apis/postproxy-social-media-api/revisions/d54482ac4ce7?raw)