Skip to main content
POST
/
group
/
list
List all groups with filters and pagination
curl --request POST \
  --url https://api.wppfy.com/group/list \
  --header 'Content-Type: application/json' \
  --header 'token: <api-key>' \
  --data '
{
  "page": 1,
  "pageSize": 50,
  "limit": 123,
  "offset": 0,
  "search": "<string>",
  "force": false,
  "noParticipants": false
}
'
{
  "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>"
    }
  ],
  "pagination": {
    "totalRecords": 123,
    "pageSize": 123,
    "currentPage": 123,
    "totalPages": 123,
    "hasNextPage": true,
    "hasPreviousPage": true
  }
}

Authorizations

token
string
header
required

Body

application/json
page
integer
default:1

Page number for pagination (default 1)

pageSize
integer
default:50

Number of results per page (default 50, maximum 1000)

limit
integer

Optional alias for pageSize

offset
integer
default:0

Zero-based offset; if provided recalculates the page

Text to filter groups by name/JID

force
boolean
default:false

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

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.

Response

List of groups retrieved successfully

groups
object[]

Detailed list of groups

pagination
object