Sign in

v1

latestOpenAPI 3.0.02026-07-2411724301.7 KB
Groups

Get Group Information

The Get Group Information API retrieves information about WhatsApp groups created under a specified WhatsApp Business number.

get/v2/{sid}/whatsapp/{fromNumber}/groups

Path parameters

sidstring required

Account SID (Security Identifier).

fromNumberstring required

WhatsApp business number in format 91xxxxxxxxxx

Query parameters

group_idstring

Optional parameter to fetch information of a particular group

all_participantsboolean

If passed true, the API gives all participants of the group. Otherwise, by default the API responds only with active participants.

status'active' | 'suspended' | 'deleted'

Filter groups based on status

limitinteger

Number of groups to fetch in API response. By default, the API returns 25 groups.

offsetinteger

Skips the given number of groups in API response

Response

Group information fetched successfully

codestring
messagestring
errorobject
limitinteger
totalinteger

Example response

{
  "code": "WA200",
  "message": "Request Processed Successfully",
  "data": [
    {
      "group": {
        "business_phone_number": "xxxxxxx",
        "company_id": "<CompanyId>",
        "description": "Testing group APIs",
        "group_id": "<GroupID>",
        "group_link": "<GroupLink>",
        "id": 102,
        "request_id": "8A416D04E3B77401EB10A3540CE32782",
        "status": "Deleted",
        "subject": "GroupTesting2",
        "waba_id": "<WABA ID>"
      },
      "participants": [
        {
          "id": 27,
          "status": "Active",
          "user_phone_number": "xxxxxxx"
        }
      ]
    }
  ],
  "error": {},
  "limit": 25,
  "total": 2
}