WhatsApp Gateway
API referenceGroups

Get one group

GET
/api/v1/sessions/{session}/groups/{gid}

Return stored group details by gid.

Authorization

AuthorizationBearer <token>

Send Authorization: Bearer <token>. The token can be a login JWT from the frontend or an api-key for a script. JWT access comes from the person's organization role. Api-key access comes from the permissions saved on the key.

In: header

Path Parameters

session*string

WhatsApp session id that owns the group.

Example"01HZ0SESSION0000000000000"
gid*string

Group JID, usually ending in @g.us. Percent-encode reserved characters such as @ in the URL path.

Example"120363041234567890@g.us"

Response Body

application/json

application/json

curl -X GET "https://example.com/api/v1/sessions/01HZ0SESSION0000000000000/groups/120363041234567890@g.us"
{  "createdAtWa": 1700000000000,  "description": "Coordination for Q3 launch",  "firstSeenAt": 1719662400000,  "groupJid": "120363021234567890@g.us",  "id": 512,  "isAnnounce": false,  "isLocked": false,  "ownerJid": "6281234567890@s.whatsapp.net",  "participantCount": 42,  "subject": "Project Team",  "updatedAt": 1719662400000}
{  "error": {    "code": "not_found",    "details": {      "property1": null,      "property2": null    },    "message": "session not found"  }}