Skip to main content
GET
/
group
/
findGroupInfos
/
:instanceName
curl --request GET \
  --url 'https://api.example.com/group/findGroupInfos/[email protected]' \
  --header 'apikey: YOUR_API_KEY'
{
  "id": "[email protected]",
  "subject": "Project Team",
  "subjectOwner": "[email protected]",
  "subjectTime": 1709553600,
  "size": 5,
  "creation": 1709467200,
  "owner": "[email protected]",
  "desc": "Team collaboration group for the new project",
  "descId": "3EB0ABC123456789",
  "descOwner": "[email protected]",
  "descTime": 1709553600,
  "participants": [
    {
      "id": "[email protected]",
      "isAdmin": true,
      "isSuperAdmin": true
    },
    {
      "id": "[email protected]",
      "isAdmin": true,
      "isSuperAdmin": false
    },
    {
      "id": "[email protected]",
      "isAdmin": false,
      "isSuperAdmin": false
    }
  ],
  "announce": false,
  "restrict": true,
  "ephemeralDuration": 0,
  "inviteCode": "F1EX5QZxO181L3TMVP31gY"
}

Overview

You can fetch comprehensive information about a group, including its metadata, participants, settings, and description.

Authentication

This endpoint requires authentication via the apikey header.
header.apikey
string
required
Your Evolution API key for authentication.

Path Parameters

path.instanceName
string
required
The name of your WhatsApp instance.

Query Parameters

groupJid
string
required
The WhatsApp group JID. You can provide it with or without the @g.us suffix (e.g., 120363123456789 or [email protected]).

Response

id
string
The WhatsApp JID of the group.
subject
string
The group name.
subjectOwner
string
The JID of who last changed the group subject.
subjectTime
number
Unix timestamp of when the subject was last changed.
size
number
Number of participants in the group.
creation
number
Unix timestamp of when the group was created.
owner
string
The JID of the group creator.
desc
string
The group description.
descId
string
Unique identifier for the current description.
descOwner
string
The JID of who last changed the description.
descTime
number
Unix timestamp of when the description was last changed.
participants
array
Array of group participants.
announce
boolean
Whether the group is announcement-only (only admins can send messages).
restrict
boolean
Whether the group settings are restricted (only admins can change group info).
ephemeralDuration
number
Disappearing messages duration in seconds (0 means disabled).
inviteCode
string
The group’s current invite code.
curl --request GET \
  --url 'https://api.example.com/group/findGroupInfos/[email protected]' \
  --header 'apikey: YOUR_API_KEY'
{
  "id": "[email protected]",
  "subject": "Project Team",
  "subjectOwner": "[email protected]",
  "subjectTime": 1709553600,
  "size": 5,
  "creation": 1709467200,
  "owner": "[email protected]",
  "desc": "Team collaboration group for the new project",
  "descId": "3EB0ABC123456789",
  "descOwner": "[email protected]",
  "descTime": 1709553600,
  "participants": [
    {
      "id": "[email protected]",
      "isAdmin": true,
      "isSuperAdmin": true
    },
    {
      "id": "[email protected]",
      "isAdmin": true,
      "isSuperAdmin": false
    },
    {
      "id": "[email protected]",
      "isAdmin": false,
      "isSuperAdmin": false
    }
  ],
  "announce": false,
  "restrict": true,
  "ephemeralDuration": 0,
  "inviteCode": "F1EX5QZxO181L3TMVP31gY"
}

Usage Notes

You must be a member of the group to retrieve its information.
The @g.us suffix is automatically added if you provide only the numeric group ID.

Build docs developers (and LLMs) love