Group Details

GET

api

group

info

:instance

Group Details

curl --request GET \
  --url https://api.example.com/api/group/info/:instance \
  --header 'token: <token>'

const options = {method: 'GET', headers: {token: '<token>'}};

fetch('https://api.example.com/api/group/info/:instance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

Description

Returns the full GroupDetail: name, description, picture, invite link, creator, list of participants (with lid), permissions, and metadata (who changed name / description). Accepts the identifier in any format, JID, invite code, or link.

Examples

By JID

Fetch the group’s details by passing the JID 120363406289005073@g.us in identifier. By default, the response includes the full participant list.

curl -X GET "https://ryzeapi.cloud/api/group/info/$Instance_Name?identifier=120363406289005073@g.us" \
  -H "token: $Token_Instance"

await fetch(`https://ryzeapi.cloud/api/group/info/${process.env.Instance_Name}?identifier=120363406289005073@g.us`, {
  method: "GET",
  headers: {
    "token": process.env.Token_Instance
  }
});

import os, requests

requests.get(
    f"https://ryzeapi.cloud/api/group/info/{os.environ['Instance_Name']}?identifier=120363406289005073@g.us",
    headers={
        "token": os.environ["Token_Instance"]
    }
)

package main

import (
    "net/http"
    "os"
)

func main() {
    req, _ := http.NewRequest("GET", "https://ryzeapi.cloud/api/group/info/"+os.Getenv("Instance_Name")+"?identifier=120363406289005073@g.us", nil)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    http.DefaultClient.Do(req)
}

By link

Resolve the group from the invite link https://chat.whatsapp.com/ABC123XYZ. The service extracts the code, discovers the JID, and returns the same data as the JID lookup.

curl -X GET "https://ryzeapi.cloud/api/group/info/$Instance_Name?identifier=https://chat.whatsapp.com/ABC123XYZ" \
  -H "token: $Token_Instance"

await fetch(`https://ryzeapi.cloud/api/group/info/${process.env.Instance_Name}?identifier=https://chat.whatsapp.com/ABC123XYZ`, {
  method: "GET",
  headers: {
    "token": process.env.Token_Instance
  }
});

import os, requests

requests.get(
    f"https://ryzeapi.cloud/api/group/info/{os.environ['Instance_Name']}?identifier=https://chat.whatsapp.com/ABC123XYZ",
    headers={
        "token": os.environ["Token_Instance"]
    }
)

package main

import (
    "net/http"
    "os"
)

func main() {
    req, _ := http.NewRequest("GET", "https://ryzeapi.cloud/api/group/info/"+os.Getenv("Instance_Name")+"?identifier=https://chat.whatsapp.com/ABC123XYZ", nil)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    http.DefaultClient.Do(req)
}

Without participants

Add participants=false to the query to receive only the group’s metadata, without the member list. Useful when you only need the name / description / permissions in large groups.

curl -X GET "https://ryzeapi.cloud/api/group/info/$Instance_Name?identifier=ABC123XYZ&participants=false" \
  -H "token: $Token_Instance"

await fetch(`https://ryzeapi.cloud/api/group/info/${process.env.Instance_Name}?identifier=ABC123XYZ&participants=false`, {
  method: "GET",
  headers: {
    "token": process.env.Token_Instance
  }
});

import os, requests

requests.get(
    f"https://ryzeapi.cloud/api/group/info/{os.environ['Instance_Name']}?identifier=ABC123XYZ&participants=false",
    headers={
        "token": os.environ["Token_Instance"]
    }
)

package main

import (
    "net/http"
    "os"
)

func main() {
    req, _ := http.NewRequest("GET", "https://ryzeapi.cloud/api/group/info/"+os.Getenv("Instance_Name")+"?identifier=ABC123XYZ&participants=false", nil)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    http.DefaultClient.Do(req)
}

Success response

Returns the full GroupDetail: metadata (name, description, image, inviteLink, createdBy, createdAt), the participants list (only present when participants=true, with lid for cross-device correlation), resolved groupSettings, and metadata containing authorship for the latest name/description changes. The URL in image is signed by WhatsApp and expires in ~1h.

200 OK

{
  "success": true,
  "message": "Group information retrieved successfully",
  "group": {
    "jid": "120363406289005073@g.us",
    "name": "Dev Team",
    "description": "Technical discussions",
    "image": "https://pps.whatsapp.net/...",
    "inviteCode": "ABC123XYZ",
    "inviteLink": "https://chat.whatsapp.com/ABC123XYZ",
    "createdBy": "5511999999999@s.whatsapp.net",
    "createdAt": "2026-01-15T10:30:00Z",
    "participantCount": 3,
    "participants": [
      {
        "jid": "5511999999999@s.whatsapp.net",
        "lid": "199789077627112@lid",
        "isAdmin": true,
        "isSuperAdmin": false,
        "joinedAt": null
      }
    ],
    "groupSettings": {
      "membersCanEditInfo": true,
      "membersCanSendMessages": true,
      "membersCanAddOthers": false,
      "requireAdminApproval": false
    },
    "metadata": {
      "nameSetAt": "2026-01-15T10:30:00Z",
      "nameSetBy": "5511999999999@s.whatsapp.net",
      "descriptionSetAt": "2026-02-20T14:00:00Z",
      "descriptionSetBy": "5521988888888@s.whatsapp.net"
    },
    "isCommunity": false,
    "isParent": false,
    "isDefaultSubGroup": false,
    "isEphemeral": false,
    "isIncognito": false,
    "isSuspended": false
  }
}

Path parameters

string

required

Instance name.

Headers

string

required

TokenAccount or TokenInstance.

Query

string

required

JID @g.us, invite code (ABC123XYZ), or full link (https://chat.whatsapp.com/ABC123XYZ).

boolean

default:"true"

When false, omits the participant list (lighter response).

Notes

When the identifier is a code / link, the service resolves it to a JID before fetching the detail, you must be in the group (or join it first) to see the internal data.
The lid field corresponds to whatsmeow’s “lite” identifier for the user; useful for correlating messages sent from other devices.
The URL in image is temporary (signed by WhatsApp; valid for ~1h).

Errors

HTTP	Message
400	`The 'identifier' query parameter is required (can be group JID, invite code, or invite link)`
400	`failed to resolve group from identifier (not a valid JID, code, or link)`
404	`Group not found or you are not a member of this group`

Envelope:

{
  "success": false,
  "error": { "message": "Group not found or you are not a member of this group" }
}

Introduction

Instance

Events

Messages

Calls

Groups

Communities

Newsletter

Profile

Chat

Chatwoot

Typebot

Observability

Description

Examples

By JID

By link

Without participants

Success response

Path parameters

Headers

Query

Notes

Errors

​Description

​Examples

​By JID

​By link

​Without participants

​Success response

​Path parameters

​Headers

​Query

​Notes

​Errors

Description

Examples

By JID

By link

Without participants

Success response

Path parameters

Headers

Query

Notes

Errors