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

# Listar Grupos

> Listar todos os grupos em que a instância participa



## OpenAPI

````yaml GET /wa/instances/{instance_id}/groups
openapi: 3.1.0
info:
  title: Zapster API
  description: ''
  version: 1.0.0
servers:
  - url: https://api.zapsterapi.com/v1
    description: Produção
security: []
tags: []
paths:
  /wa/instances/{instance_id}/groups:
    get:
      tags: []
      summary: /wa/instances/{instance_id}/groups
      description: Listar todos os grupos em que a instância participa
      parameters:
        - name: instance_id
          in: path
          description: ''
          required: true
          example: ''
          schema:
            type: string
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  required:
                    - description
                    - id
                    - invite_code
                    - is_announcement
                    - is_restricted
                    - name
                    - owner
                    - profile_picture
                    - total_participants
                  properties:
                    description:
                      type: string
                      example: My group description
                      description: >-
                        Descrição do grupo que também pode ser vista na seção de
                        detalhamento do grupo.
                    id:
                      type: string
                      example: '120363279776130958'
                      description: Identificador único do grupo.
                    invite_code:
                      type: string
                      example: XobOM8UBL8EXR3dXoGozql
                      nullable: true
                      description: >-
                        Código do convite do grupo que pode ser usado para
                        convitar outros usuários.
                    is_community:
                      type: boolean
                      example: true
                      description: >-
                        Indica se o grupo é uma comunidade (pode ser um grupo de
                        anúncios).
                    is_announcement:
                      type: boolean
                      example: true
                      description: >-
                        Indica se o grupo é apenas para anúncios (ninguém pode
                        enviar mensagens, só o dono).
                    is_restricted:
                      type: boolean
                      example: true
                      description: >-
                        Mostra se o grupo tem acesso restrito (apenas pessoas
                        autorizadas podem participar).
                    approval_mode:
                      type: string
                      enum:
                        - auto_approve
                        - requires_approval
                      description: Define como os participantes serão aprovados no grupo.
                      example: requires_approval
                    name:
                      type: string
                      example: My group name
                      description: O nome dado ao grupo.
                    owner:
                      type: object
                      required:
                        - id
                        - profile_picture
                      properties:
                        id:
                          type: string
                          example: '558796139874'
                          description: >-
                            Número do dono do grupo no formato `DDI` + `DDD` +
                            `Telefone`.
                        name:
                          type: string
                          nullable: true
                          example: Owner Name
                          description: O nome do dono do grupo (se disponível).
                        profile_picture:
                          type: string
                          format: uri
                          nullable: true
                          example: https://zapsterapi.s3.us-east-1.amazonaws.com/...
                          description: O link para a foto de perfil do dono do grupo.
                    profile_picture:
                      type: string
                      format: uri
                      example: https://zapsterapi.s3.us-east-1.amazonaws.com/...
                      description: Profile picture URL of the group.
                    total_participants:
                      type: integer
                      example: 2
                      description: Total number of participants in the group.
        '403':
          description: unexpected error
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      required:
                        - code
                        - message
                      type: object
                      properties:
                        code:
                          type: string
                          examples:
                            - not_allowed
                        message:
                          type: string
                          examples:
                            - >-
                              Access to the group management API is not enabled
                              for your account. Please subscribe to a suitable
                              plan to gain access.
      deprecated: false
      security:
        - bearer: []
components:
  securitySchemes:
    bearer:
      type: http
      scheme: bearer

````