WhatsApp Gateway
API referenceGroups

List a group's members

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

Return stored members for one group.

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/members"
{  "data": [    {      "firstSeenAt": 1719662400000,      "groupJid": "120363021234567890@g.us",      "id": 7781,      "lastSeenAt": 1719662400000,      "lid": "205227043110953@lid",      "role": "member",      "sessionId": "01J9ZX8K2QHV0M3T6R7P4N5W8C",      "tag": "~Alice"    }  ],  "nextCursor": "string"}
{  "error": {    "code": "not_found",    "details": {      "property1": null,      "property2": null    },    "message": "session not found"  }}