EVevolution-foundation
Group Controller

Fetch All Groups

Changed on

Fetch all groups

get/group/fetchAllGroups/{instance}

Request

  • Base URL
    https://evolution-example
  • URL
    https://evolution-example/group/fetchAllGroups/{instance}
  • Auth
    API key in header apikey

Path parameters

instancestring required

Name of the instance

Query parameters

getParticipantsboolean required

Whether to get the group members or not

Response

Ok

idstring required

The ID of the group.

subjectstring required

The subject (name) of the group.

subjectOwnerstring required

The ID of the user who set the subject.

subjectTimeinteger required

The timestamp when the subject was set.

pictureUrlstring

URL of the group's profile picture.

sizeinteger required

The number of participants in the group.

creationinteger required

The timestamp when the group was created.

ownerstring required

The ID of the group owner.

descstring

The description of the group.

descIdstring

The ID of the description message.

restrictboolean required

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

announceboolean required

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

Example response

[
  {
    "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
  }
]

Changes

  • v2c153448703e5Revision changes
    • breaking

      the query request parameter getParticipants became required

    • info

      api operation id fetchAllGroups was added

    • info

      the endpoint scheme security ApiKeyAuth was added to the API

    • info

      api tag Group Controller added

    • info

      api tag Group removed

  • v20c4620ca5ed5Revision changes
    • info

      api operation id fetchAllGroups removed and replaced with

    • info

      the endpoint scheme security ApiKeyAuth was removed from the API

    • info

      api tag Group added

    • info

      api tag Group Controller removed

    • info

      the query request parameter getParticipants became optional