Skip to main content
GET
/
group
/
list
List all groups
curl --request GET \
  --url https://api.wppfy.com/group/list \
  --header 'token: <api-key>'
{
  "groups": [
    {
      "JID": "jid8@g.us",
      "OwnerJID": "1232@s.whatsapp.net",
      "Name": "Grupo de Suporte",
      "NameSetAt": "2023-11-07T05:31:56Z",
      "NameSetBy": "<string>",
      "Topic": "<string>",
      "IsLocked": true,
      "IsAnnounce": true,
      "AnnounceVersionID": "<string>",
      "IsEphemeral": true,
      "DisappearingTimer": 1,
      "IsIncognito": true,
      "IsParent": true,
      "IsJoinApprovalRequired": true,
      "LinkedParentJID": "<string>",
      "IsDefaultSubGroup": true,
      "GroupCreated": "2023-11-07T05:31:56Z",
      "ParticipantVersionID": "<string>",
      "Participants": [
        "<unknown>"
      ],
      "MemberAddMode": "admin_add",
      "OwnerCanSendMessage": true,
      "OwnerIsAdmin": true,
      "DefaultSubGroupId": "<string>",
      "invite_link": "<string>",
      "request_participants": "<string>"
    }
  ]
}

Authorizations

​
token
string
header
required

Query Parameters

​
force
boolean
default:false

If set to true, forces the update of the group cache. Useful to ensure that the latest information is retrieved.

Behaviors:

  • false (default): Uses cached information
  • true: Fetches updated data directly from WhatsApp
​
noparticipants
boolean
default:false

If set to true, returns the list of groups without including participants. Useful for optimizing the response when participant data is not needed.

Behaviors:

  • false (default): Returns groups with full participant list
  • true: Returns groups without including participants

Response

List of groups retrieved successfully

​
groups
object[]

Detailed list of groups