Sign in

v1

latestOpenAPI 3.0.02026-07-2491237338.9 KB
WhatsApp Groups

Retrieve a group

Retrieves a WhatsApp group.

get/whatsapp/{businessPhoneNumber}/groups/{groupId}

Path parameters

businessPhoneNumberstring required
Example:+16315551111

The WhatsApp business phone number in E.164 format.

groupIdstring required
Example:120363345678901234@g.us

WhatsApp group ID.

Response

Successfully retrieved the group.

groupIdstring

WhatsApp group ID.

subjectstring

The group subject.

descriptionstring

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.
suspendedboolean

Whether the group is suspended.

creationTimestampinteger

Unix timestamp indicating when the group was created.

totalParticipantCountinteger

Total number of participants in the group.

Example response

{
  "groupId": "120363345678901234@g.us",
  "subject": "New Purchase Inquiry",
  "description": "Group for purchase inquiries.",
  "joinApprovalMode": "auto_approve",
  "creationTimestamp": 1739321024,
  "totalParticipantCount": 3,
  "participants": [
    {
      "waId": "16315551111",
      "userId": "US.1234",
      "parentUserId": "US.parent123",
      "username": "John"
    }
  ]
}