API referenceGroups
List a session's groups
List groups from stored data for one session.
Returns all groups for the session.
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 to read groups from.
Example
"01HZ0SESSION0000000000000"Response Body
application/json
application/json
curl -X GET "https://example.com/api/v1/sessions/01HZ0SESSION0000000000000/groups"{ "data": [ { "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 } ], "nextCursor": "string"}{ "error": { "code": "not_found", "details": { "property1": null, "property2": null }, "message": "session not found" }}