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": "Grupo de Soporte",
      "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": "Tiempo de espera de la solicitud agotado"
}

{
  "error": "<string>"
}

Grupos y Comunidades

Listar grupos por páginas (recomendado)

Use esta operación para buscar grupos y elegir cuál abrir. Prefiera una página de resúmenes sin la lista de miembros; consulte POST /group/info cuando necesite los detalles de un grupo.

Uso recomendado

Envíe search, limit y offset, con noParticipants=true. El tamaño de página predeterminado es 50 y el máximo es 1000. La búsqueda considera el nombre, el JID, la descripción del grupo y el nombre de la comunidad a la que pertenece. La respuesta contiene groups y pagination.

Opciones avanzadas y compatibilidad

El valor HTTP predeterminado de noParticipants sigue siendo false para preservar las integraciones existentes. El ejemplo recomendado usa true explícitamente.
Para participantes y perfiles completos, consulte solo el grupo seleccionado en POST /group/info.
force solicita una actualización de WhatsApp. Normalmente basta con dejar que la API actualice cuando sea necesario; no use force en polling continuo.

Una actualización remota de la lista aún puede recibir participantes de WhatsApp; noParticipants=true evita cargarlos en la lectura de la página y enviarlos en la respuesta.

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": "Grupo de Soporte",
      "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": "Tiempo de espera de la solicitud agotado"
}

{
  "error": "<string>"
}

Autorizaciones

token

string

header

requerido

Cuerpo

application/json

limit

integer

predeterminado:50

Cantidad máxima de resultados por página (predeterminado 50, máximo 1000)

Rango requerido: 1 <= x <= 1000

offset

integer

predeterminado:0

Desplazamiento con base cero

string

Búsqueda por nombre, tema, JID o nombre de la comunidad principal.

force

boolean

predeterminado:false

Avanzado: solicita una actualización remota. No es necesario en el flujo normal; no lo use en polling continuo.

noParticipants

boolean

predeterminado:false

Compatibilidad: true devuelve resúmenes sin miembros, como en el ejemplo recomendado. El valor predeterminado HTTP sigue siendo false.

Respuesta

Lista de grupos obtenida correctamente

groups

object[]

Lista detallada de grupos

Show child attributes

pagination

object

Show child attributes

Instancia

CRM

Proxy

Perfil

Enviar Mensaje

Mensaje Async

Acciones en el mensaje y Búsqueda

Grupos y Comunidades

Newsletters y Canales

Server-Sent Events (SSE)

Bloqueos

Etiquetas

Chats

Contactos

Llamadas

Integración con Chatwoot

Business

Respuestas Rápidas