---
title: "Retrieve a group"
method: GET
path: "/whatsapp/{businessPhoneNumber}/groups/{groupId}"
tags: ["WhatsApp Groups"]
---

# Retrieve a group

`GET /whatsapp/{businessPhoneNumber}/groups/{groupId}`

Retrieves a WhatsApp group.

## Path parameters

- `businessPhoneNumber` string, required
- `groupId` string, required

## Response `200`

Successfully retrieved the group.

- WhatsappGroup — WhatsApp group object.
  - `groupId` string — WhatsApp group ID.
  - `subject` string — The group subject.
  - `description` string — The group description.
  - `joinApprovalMode` 'approval_required' | 'auto_approve' — WhatsApp group join approval mode. - `approval_required`: New members must be approved before joining. - `auto_approve`: New members can join without approval.
  - `suspended` boolean — Whether the group is suspended.
  - `creationTimestamp` integer — Unix timestamp indicating when the group was created.
  - `totalParticipantCount` integer — Total number of participants in the group.
  - `participants` WhatsappGroupParticipant[] — Group participants.
    - `waId` string — WhatsApp user ID.
    - `userId` string — Business-scoped user ID.
    - `parentUserId` string — Parent business-scoped user ID.
    - `username` string — WhatsApp username.

## Other responses

- `400` — Bad request. Invalid request parameters.
- `404` — The requested resource does not exist.

---

[API](https://skmtc.dev/ycloud/apis/ycloud-api.md) · [All operations](https://skmtc.dev/ycloud/apis/ycloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ycloud/ycloud-api/revisions/4e13d3ca9df8/schema)
