> ## Documentation Index
> Fetch the complete documentation index at: https://docs.notifique.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Listar grupos WhatsApp

> Lista os grupos desta conexão WhatsApp.



## OpenAPI

````yaml /whatsapp-api/api-reference/openapi-whatsapp.json get /v1/whatsapp/instances/{instanceId}/groups
openapi: 3.0.3
info:
  title: Notifique API — WhatsApp
  description: >-
    Envie mensagens WhatsApp e gerencie conexões. Autentique com `Authorization:
    Bearer sk_live_...` ou `x-api-key`.
  version: 1.0.0
servers:
  - url: https://api.notifique.dev
    description: Produção
security:
  - ntfWaBearerAuth: []
  - ntfWaApiKeyHeader: []
tags:
  - name: Mensagens
    description: Enviar, listar, editar e cancelar mensagens
  - name: Instâncias
    description: >-
      Cadastre e gerencie os números de WhatsApp conectados — cada número é uma
      **instância** (o telefone por onde entram e saem as mensagens).
  - name: Grupos
    description: Grupos (só conexão não oficial)
paths:
  /v1/whatsapp/instances/{instanceId}/groups:
    get:
      tags:
        - Grupos
      summary: Listar grupos WhatsApp
      description: Lista os grupos desta conexão WhatsApp.
      operationId: ntfWa_getV1WhatsappInstancesInstanceIdGroups
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
          description: ID da instância no workspace.
        - name: page
          in: query
          required: false
          schema:
            type: integer
            default: 1
          description: Página da listagem (a partir de 1).
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            default: 20
            maximum: 100
          description: Quantidade por página (máx. 100).
      responses:
        '200':
          description: >-
            Lista de grupos (paginada) ou indicação de que a lista está sendo
            carregada.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  loading:
                    type: boolean
                    description: >-
                      Quando true, a lista ainda está sendo obtida; data virá
                      vazio — tente novamente em alguns segundos.
                  message:
                    type: string
                    description: Mensagem quando loading é true.
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: 'JID do grupo (ex.: 120363295648424210@g.us)'
                        name:
                          type: string
                        participantsCount:
                          type: integer
                        owner:
                          type: string
                        creation:
                          type: integer
                  pagination:
                    type: object
                    properties:
                      page:
                        type: integer
                      limit:
                        type: integer
                      total:
                        type: integer
              examples:
                withData:
                  summary: Sucesso — dados em cache (paginado)
                  value:
                    success: true
                    data:
                      - id: 120363295648424210@g.us
                        name: Meu Grupo
                        participantsCount: 5
                        owner: 5511999999999@s.whatsapp.net
                        creation: 1699000000
                    pagination:
                      page: 1
                      limit: 20
                      total: 5
                loading:
                  summary: Carregando — tentar novamente em breve
                  value:
                    success: true
                    loading: true
                    message: >-
                      Lista de grupos está sendo carregada. Tente novamente em
                      alguns segundos.
                    data: []
                    pagination:
                      page: 1
                      limit: 20
                      total: 0
        '401':
          description: API Key ausente ou inválida.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfWa_ErrorResponse'
        '402':
          description: Plano expirado ou suspenso.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfWa_ErrorResponse'
        '403':
          description: >-
            Escopo whatsapp:groups ausente ou instância oficial
            (WHATSAPP_GROUPS_UNOFFICIAL_ONLY).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfWa_ErrorResponse'
        '404':
          description: Instância não encontrada.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfWa_ErrorResponse'
        '502':
          description: Erro ao processar requisição.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfWa_ErrorResponse'
components:
  schemas:
    NtfWa_ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
          description: 'Rótulo HTTP do erro (ex.: Unauthorized, Bad Request, Not Found).'
        message:
          type: string
          description: >-
            Mensagem legível para exibir ao usuário (localizada via
            Accept-Language / x-locale quando aplicável).
        code:
          type: string
          description: >-
            Código estável da API v1 (enum). Sempre presente em erros. Use com o
            status HTTP para decidir retry ou correção. Ver [Respostas de
            erro](/guides/conceitos/resposta-de-erros).
        details:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
              message:
                type: string
        note:
          type: string
      required:
        - success
        - error
        - message
        - code
  securitySchemes:
    ntfWaBearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        API Key no header Authorization. Exemplo: `Authorization: Bearer
        sk_live_xxxxx`
    ntfWaApiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key
      description: API Key no header x-api-key.

````