GET

https://{server-url}

/
group
/
fetchAllGroups
/
{instance}
curl --request GET \
  --url https://{server-url}/group/fetchAllGroups/{instance} \
  --header 'apikey: <api-key>'
[
  {
    "id": "120363295648424210@g.us",
    "subject": "Example Group",
    "subjectOwner": "553198296801@s.whatsapp.net",
    "subjectTime": 1714769954,
    "pictureUrl": null,
    "size": 1,
    "creation": 1714769954,
    "owner": "553198296801@s.whatsapp.net",
    "desc": "optional",
    "descId": "BAE57E16498982ED",
    "restrict": false,
    "announce": false
  }
]

Authorizations

apikey
string
headerrequired

Your authorization key header

Path Parameters

instance
string
required

ID of the instance to connect

Query Parameters

getParticipants
boolean
required

Whether to get the group members or not

Response

200 - application/json
id
string
required

The ID of the group.

subject
string
required

The subject (name) of the group.

subjectOwner
string
required

The ID of the user who set the subject.

subjectTime
integer
required

The timestamp when the subject was set.

pictureUrl
string

URL of the group's profile picture.

size
integer
required

The number of participants in the group.

creation
integer
required

The timestamp when the group was created.

owner
string
required

The ID of the group owner.

desc
string

The description of the group.

descId
string

The ID of the description message.

restrict
boolean
required

Indicates if the group is restricted (only admins can send messages).

announce
boolean
required

Indicates if the group is an announcement group (only admins can send messages).

Find Group by JIDFind Group Members