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

# Listar comunidades

> Lista as comunidades de que a instância participa, cada uma com seu `id` e nome.



## OpenAPI

````yaml /pt-br/api-reference/openapi.json get /communities
openapi: 3.1.0
info:
  title: Zapfy API
  description: >-
    API de WhatsApp multi-tenant. Envie mensagens e gerencie webhooks por uma
    superfície única.
  version: 1.0.0
servers:
  - url: https://api.zapfy.io/v1
security:
  - accountToken: []
paths:
  /communities:
    get:
      tags:
        - Comunidades
      summary: Listar comunidades
      description: >-
        Lista as comunidades de que a instância participa, cada uma com seu `id`
        e nome.
      responses:
        '200':
          $ref: '#/components/responses/CommunityList'
        '401':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '502':
          $ref: '#/components/responses/Error'
      security:
        - instanceToken: []
components:
  responses:
    CommunityList:
      description: Comunidades de que a instância participa.
      content:
        application/json:
          schema:
            type: object
            properties:
              data:
                type: array
                items:
                  $ref: '#/components/schemas/CommunitySummary'
    Error:
      description: Erro.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
                example: Instance not found
  schemas:
    CommunitySummary:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/CommunityId'
          description: id da comunidade.
        name:
          type: string
          description: Nome da comunidade.
          example: Minha Comunidade
    CommunityId:
      type: string
      description: >-
        id da comunidade: o `id` `...@g.us` devolvido ao criar a comunidade
        (POST /communities/create). Use exatamente como recebido.
      example: 120363012345678901@g.us
  securitySchemes:
    accountToken:
      type: http
      scheme: bearer
      description: Token de conta (`zpfy_acct_...`) — gerencia instâncias e webhooks.
    instanceToken:
      type: http
      scheme: bearer
      description: Token de instância (`zpfy_inst_...`) — envia mensagens.

````