Get Group Info

Retrieve detailed information about a WhatsApp group.

GET /group/findGroupInfos/:instanceName

cURL

curl --request GET \
  --url 'https://api.example.com/group/findGroupInfos/my-instance?groupJid=[e-mail]' \
  --header 'apikey: YOUR_API_KEY'

const groupJid = '[e-mail]';

const response = await fetch(
  `https://api.example.com/group/findGroupInfos/my-instance?groupJid=${groupJid}`,
  {
    method: 'GET',
    headers: {
      'apikey': 'YOUR_API_KEY'
    }
  }
);

const data = await response.json();

import requests

group_jid = '[e-mail]'

response = requests.get(
    f'https://api.example.com/group/findGroupInfos/my-instance?groupJid={group_jid}',
    headers={'apikey': 'YOUR_API_KEY'}
)

data = response.json()

200 Success

{
  "id": "[e-mail]",
  "subject": "Project Team",
  "subjectOwner": "[e-mail]",
  "subjectTime": 1709553600,
  "size": 5,
  "creation": 1709467200,
  "owner": "[e-mail]",
  "desc": "Team collaboration group for the new project",
  "descId": "3EB0ABC123456789",
  "descOwner": "[e-mail]",
  "descTime": 1709553600,
  "participants": [
    {
      "id": "[e-mail]",
      "isAdmin": true,
      "isSuperAdmin": true
    },
    {
      "id": "[e-mail]",
      "isAdmin": true,
      "isSuperAdmin": false
    },
    {
      "id": "[e-mail]",
      "isAdmin": false,
      "isSuperAdmin": false
    }
  ],
  "announce": false,
  "restrict": true,
  "ephemeralDuration": 0,
  "inviteCode": "F1EX5QZxO181L3TMVP31gY"
}

{
  "error": "The group id needs to be informed in the query",
  "message": "ex: \"groupJid=[e-mail]\""
}

{
  "error": "Unauthorized",
  "message": "Invalid API key"
}

{
  "error": "Group not found",
  "message": "The specified group does not exist or you are not a member"
}

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 [e-mail]).

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.

Show properties

id · string

Participant’s WhatsApp JID.

isAdmin · boolean

Whether the participant is an admin.

isSuperAdmin · boolean

Whether the participant is a super admin (group creator).

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

curl --request GET \
  --url 'https://api.example.com/group/findGroupInfos/my-instance?groupJid=[e-mail]' \
  --header 'apikey: YOUR_API_KEY'

const groupJid = '[e-mail]';

const response = await fetch(
  `https://api.example.com/group/findGroupInfos/my-instance?groupJid=${groupJid}`,
  {
    method: 'GET',
    headers: {
      'apikey': 'YOUR_API_KEY'
    }
  }
);

const data = await response.json();

import requests

group_jid = '[e-mail]'

response = requests.get(
    f'https://api.example.com/group/findGroupInfos/my-instance?groupJid={group_jid}',
    headers={'apikey': 'YOUR_API_KEY'}
)

data = response.json()

200 Success

{
  "id": "[e-mail]",
  "subject": "Project Team",
  "subjectOwner": "[e-mail]",
  "subjectTime": 1709553600,
  "size": 5,
  "creation": 1709467200,
  "owner": "[e-mail]",
  "desc": "Team collaboration group for the new project",
  "descId": "3EB0ABC123456789",
  "descOwner": "[e-mail]",
  "descTime": 1709553600,
  "participants": [
    {
      "id": "[e-mail]",
      "isAdmin": true,
      "isSuperAdmin": true
    },
    {
      "id": "[e-mail]",
      "isAdmin": true,
      "isSuperAdmin": false
    },
    {
      "id": "[e-mail]",
      "isAdmin": false,
      "isSuperAdmin": false
    }
  ],
  "announce": false,
  "restrict": true,
  "ephemeralDuration": 0,
  "inviteCode": "F1EX5QZxO181L3TMVP31gY"
}

{
  "error": "The group id needs to be informed in the query",
  "message": "ex: \"groupJid=[e-mail]\""
}

{
  "error": "Unauthorized",
  "message": "Invalid API key"
}

{
  "error": "Group not found",
  "message": "The specified group does not exist or you are not a member"
}

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.