Skip to main content
GET
/
api
/
group
/
list
/
:instance
List Groups
curl --request GET \
  --url https://api.example.com/api/group/list/:instance \
  --header 'token: <token>'

Documentation Index

Fetch the complete documentation index at: https://docs.ryzeapi.cloud/llms.txt

Use this file to discover all available pages before exploring further.

Auth: TokenAccount or TokenInstance • Rate-limit: Global (100/min) • Idempotent: yes

​
Description

Lists every group the instance belongs to. By default, only lightweight metadata is returned (name, JID, description, creator, count). Pass includeMembers=true in the query to include the full member list, when you do, the operation timeout is extended to 60s.

​
Examples

​
List (without members)

Returns every group of the instance with lightweight metadata only (name, JID, description, creator, count). This is the default mode and the fastest for accounts with many groups. 
curl -X GET "https://ryzeapi.cloud/api/group/list/$Instance_Name" \
  -H "token: $Token_Instance"

​
List with members

Add includeMembers=true to include the full participant list of every group. The internal timeout is extended to 60s, useful when you need a complete snapshot in a single call. 
curl -X GET "https://ryzeapi.cloud/api/group/list/$Instance_Name?includeMembers=true" \
  -H "token: $Token_Instance"

​
Success response

Returns every group of the instance under groups[], with meta.total reporting the count. Each item carries lightweight metadata (name, groupJid, description, creatorJid, memberCount); the members array is populated only when includeMembers=true. There is no pagination, every group comes in a single response.
200 OK
{
  "success": true,
  "message": "2 Groups found",
  "groups": [
    {
      "name": "Dev Team",
      "groupJid": "120363406289005073@g.us",
      "description": "Technical discussions",
      "creatorJid": "5511999999999@s.whatsapp.net",
      "memberCount": 3,
      "members": [
        { "jid": "5511999999999@s.whatsapp.net", "isAdmin": true, "isSuperAdmin": false }
      ]
    }
  ],
  "meta": { "total": 2 }
}

​
Path parameters

​
instance
string
required
Instance name.

​
Headers

​
token
string
required
TokenAccount or TokenInstance.

​
Query

​
includeMembers
boolean
default:"false"
When true, includes the full member list of each group.

​
Notes

  • The members array only appears when includeMembers=true.
  • For accounts with many groups, use includeMembers=false and fetch members on demand via GET /info.
  • There is no pagination, every group comes in a single response.

​
Errors

HTTPMessage
400Instance is not connected to WhatsApp
404Instance not found
Envelope: 
{
  "success": false,
  "error": { "message": "Instance is not connected to WhatsApp" }
}