curl --request POST \
  --url https://api.wppfy.com/group/list \
  --header 'Content-Type: application/json' \
  --header 'token: <api-key>' \
  --data '
{
  "search": "Suporte",
  "limit": 50,
  "offset": 0,
  "noParticipants": true
}
'

{
  "groups": [
    {
      "JID": "jid8@g.us",
      "OwnerJID": "1232@s.whatsapp.net",
      "OwnerPN": "<string>",
      "Name": "Support Group",
      "NameSetAt": "2023-11-07T05:31:56Z",
      "NameSetBy": "<string>",
      "NameSetByPN": "<string>",
      "Topic": "<string>",
      "TopicID": "<string>",
      "TopicSetAt": "2023-11-07T05:31:56Z",
      "TopicSetBy": "<string>",
      "TopicSetByPN": "<string>",
      "TopicDeleted": true,
      "IsLocked": true,
      "IsAnnounce": true,
      "AnnounceVersionID": "<string>",
      "IsEphemeral": true,
      "DisappearingTimer": 1,
      "IsIncognito": true,
      "IsParent": true,
      "IsJoinApprovalRequired": true,
      "LinkedParentJID": "<string>",
      "IsDefaultSubGroup": true,
      "DefaultMembershipApprovalMode": "<string>",
      "GroupCreated": "2023-11-07T05:31:56Z",
      "CreatorCountryCode": "<string>",
      "ParticipantVersionID": "<string>",
      "Participants": [
        {
          "JID": "<string>",
          "LID": "<string>",
          "PhoneNumber": "<string>",
          "IsAdmin": true,
          "IsSuperAdmin": true,
          "DisplayName": "<string>",
          "ImagePreview": "<string>",
          "Error": 1,
          "AddRequest": {
            "Code": "<string>",
            "Expiration": "2023-11-07T05:31:56Z"
          },
          "Username": "<string>"
        }
      ],
      "MemberAddMode": "",
      "AddressingMode": "",
      "OwnerCanSendMessage": true,
      "OwnerIsAdmin": true,
      "DefaultSubGroupId": "<string>",
      "invite_link": "<string>",
      "request_participants": "<string>",
      "image_url": "<string>",
      "image_preview_url": "<string>",
      "picture_id": "<string>",
      "picture_preview_id": "<string>",
      "picture_empty_at": "2023-11-07T05:31:56Z",
      "image_checked_at": "2023-11-07T05:31:56Z",
      "image_preview_checked_at": "2023-11-07T05:31:56Z",
      "parent_community": {
        "jid": "<string>",
        "name": "<string>",
        "image_url": "<string>",
        "image_preview_url": "<string>",
        "default_subgroup_jid": "<string>"
      },
      "participant_profiles": [
        {
          "jid": "<string>",
          "pn": "<string>",
          "lid": "<string>",
          "username": "<string>",
          "display_name": "<string>",
          "name": "<string>",
          "image_url": "<string>",
          "image_preview_url": "<string>",
          "picture_id": "<string>",
          "picture_preview_id": "<string>",
          "is_admin": true,
          "is_super_admin": true
        }
      ],
      "ParticipantCount": 1,
      "request_participants_lid": "<string>"
    }
  ],
  "pagination": {
    "totalRecords": 123,
    "limit": 123,
    "offset": 123,
    "hasMore": true,
    "nextOffset": 123
  }
}

{
  "error": "<string>"
}

{
  "error": "Request timeout"
}

{
  "error": "<string>"
}

Groups and Communities

List groups in pages (recommended)

Use this operation to search groups and choose which one to open. Prefer a page of summaries without the member list; query POST /group/info when you need the details of a group.

Recommended usage

Send search, limit, and offset, with noParticipants=true. The default page size is 50 and the maximum is 1000. The search considers the name, JID, group description, and the name of the community it belongs to. The response contains groups and pagination.

Advanced options and compatibility

The HTTP default for noParticipants remains false to preserve existing integrations. The recommended example uses true explicitly.
For full participants and profiles, query only the selected group in POST /group/info.
force requests a refresh from WhatsApp. Normally it is enough to let the API refresh when needed; do not use force for continuous polling.

A remote refresh of the list may still receive participants from WhatsApp; noParticipants=true avoids loading them when reading the page and sending them in the response.

POST

group

list

curl --request POST \
  --url https://api.wppfy.com/group/list \
  --header 'Content-Type: application/json' \
  --header 'token: <api-key>' \
  --data '
{
  "search": "Suporte",
  "limit": 50,
  "offset": 0,
  "noParticipants": true
}
'

{
  "groups": [
    {
      "JID": "jid8@g.us",
      "OwnerJID": "1232@s.whatsapp.net",
      "OwnerPN": "<string>",
      "Name": "Support Group",
      "NameSetAt": "2023-11-07T05:31:56Z",
      "NameSetBy": "<string>",
      "NameSetByPN": "<string>",
      "Topic": "<string>",
      "TopicID": "<string>",
      "TopicSetAt": "2023-11-07T05:31:56Z",
      "TopicSetBy": "<string>",
      "TopicSetByPN": "<string>",
      "TopicDeleted": true,
      "IsLocked": true,
      "IsAnnounce": true,
      "AnnounceVersionID": "<string>",
      "IsEphemeral": true,
      "DisappearingTimer": 1,
      "IsIncognito": true,
      "IsParent": true,
      "IsJoinApprovalRequired": true,
      "LinkedParentJID": "<string>",
      "IsDefaultSubGroup": true,
      "DefaultMembershipApprovalMode": "<string>",
      "GroupCreated": "2023-11-07T05:31:56Z",
      "CreatorCountryCode": "<string>",
      "ParticipantVersionID": "<string>",
      "Participants": [
        {
          "JID": "<string>",
          "LID": "<string>",
          "PhoneNumber": "<string>",
          "IsAdmin": true,
          "IsSuperAdmin": true,
          "DisplayName": "<string>",
          "ImagePreview": "<string>",
          "Error": 1,
          "AddRequest": {
            "Code": "<string>",
            "Expiration": "2023-11-07T05:31:56Z"
          },
          "Username": "<string>"
        }
      ],
      "MemberAddMode": "",
      "AddressingMode": "",
      "OwnerCanSendMessage": true,
      "OwnerIsAdmin": true,
      "DefaultSubGroupId": "<string>",
      "invite_link": "<string>",
      "request_participants": "<string>",
      "image_url": "<string>",
      "image_preview_url": "<string>",
      "picture_id": "<string>",
      "picture_preview_id": "<string>",
      "picture_empty_at": "2023-11-07T05:31:56Z",
      "image_checked_at": "2023-11-07T05:31:56Z",
      "image_preview_checked_at": "2023-11-07T05:31:56Z",
      "parent_community": {
        "jid": "<string>",
        "name": "<string>",
        "image_url": "<string>",
        "image_preview_url": "<string>",
        "default_subgroup_jid": "<string>"
      },
      "participant_profiles": [
        {
          "jid": "<string>",
          "pn": "<string>",
          "lid": "<string>",
          "username": "<string>",
          "display_name": "<string>",
          "name": "<string>",
          "image_url": "<string>",
          "image_preview_url": "<string>",
          "picture_id": "<string>",
          "picture_preview_id": "<string>",
          "is_admin": true,
          "is_super_admin": true
        }
      ],
      "ParticipantCount": 1,
      "request_participants_lid": "<string>"
    }
  ],
  "pagination": {
    "totalRecords": 123,
    "limit": 123,
    "offset": 123,
    "hasMore": true,
    "nextOffset": 123
  }
}

{
  "error": "<string>"
}

{
  "error": "Request timeout"
}

{
  "error": "<string>"
}

Authorizations

token

string

header

required

Body

application/json

limit

integer

default:50

Maximum number of results per page (default 50, maximum 1000)

Required range: 1 <= x <= 1000

offset

integer

default:0

Zero-based offset

string

Search by name, topic, JID or parent community name.

force

boolean

default:false

Advanced: requests a remote update. Not required in the normal flow; do not use in continuous polling.

noParticipants

boolean

default:false

Compatibility: true returns summaries without members, as in the recommended example. The HTTP default remains false.

Response

List of groups retrieved successfully

groups

object[]

Detailed list of groups

Show child attributes

pagination

object

Show child attributes

Instance

CRM

Proxy

Profile

Send Message

Async Message

Message Actions and Search

Groups and Communities

Newsletters and Channels

Server-Sent Events (SSE)

Blocklist

Labels

Chats

Contacts

Calls

Chatwoot Integration

Business

Quick Replies