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

# List all groups

> Returns every group the number belongs to. The required `getParticipants` query parameter (`"true"` or `"false"`) controls whether each group's participant list is included.



## OpenAPI

````yaml openapi.evolution-v2.json GET /group/fetchAllGroups/{instance}
openapi: 3.1.0
info:
  title: Evolution V2 Layer
  version: 1.0.0
  description: >-
    Pilot Status API Layer — Evolution V2. Base URL
    `https://pilotstatus.com.br/api/layer/evolution-v2`. Authenticate with the
    `apikey` header (your Pilot Status `ps_` key). Instance/session endpoints
    are NOT available through the layer.
servers:
  - url: https://pilotstatus.com.br/api/layer/evolution-v2
security:
  - apiKey: []
tags:
  - name: Call & Business
  - name: Chat
  - name: Group
  - name: Label
  - name: Message
  - name: Profile
  - name: Settings & Proxy
  - name: Storage (S3)
  - name: Template
paths:
  /group/fetchAllGroups/{instance}:
    get:
      tags:
        - Group
      summary: List all groups
      description: >-
        Returns every group the number belongs to. The required
        `getParticipants` query parameter (`"true"` or `"false"`) controls
        whether each group's participant list is included.
      operationId: get__group_fetchAllGroups_instance
      parameters:
        - name: instance
          in: path
          required: true
          schema:
            type: string
          description: The number's display name in the Pilot Status dashboard.
      responses:
        '200':
          description: Success — provider-native response body.
          content:
            application/json:
              schema:
                type: array
                description: >-
                  All groups the instance participates in. The 'participants'
                  field is only present when the request is made with
                  getParticipants=true.
                items:
                  type: object
                  properties:
                    id:
                      type: string
                      description: Group JID.
                    subject:
                      type: string
                      description: Group name/subject.
                    subjectOwner:
                      type: string
                      description: JID of the participant who last set the subject.
                    subjectTime:
                      type: integer
                      description: Unix timestamp (seconds) when the subject was last set.
                    pictureUrl:
                      type:
                        - string
                        - 'null'
                      description: URL of the group profile picture, or null if none.
                    size:
                      type: integer
                      description: Number of participants.
                    creation:
                      type: integer
                      description: Unix timestamp (seconds) when the group was created.
                    owner:
                      type: string
                      description: JID of the group owner/creator.
                    desc:
                      type: string
                      description: Group description text.
                    descId:
                      type: string
                      description: Identifier of the current description.
                    restrict:
                      type: boolean
                      description: If true, only admins can edit group info.
                    announce:
                      type: boolean
                      description: >-
                        If true, only admins can send messages (announcement
                        group).
                    isCommunity:
                      type: boolean
                      description: Whether this group is a community parent.
                    isCommunityAnnounce:
                      type: boolean
                      description: Whether this is a community announcement group.
                    linkedParent:
                      type:
                        - string
                        - 'null'
                      description: JID of the linked community parent, when applicable.
                    participants:
                      type: array
                      description: >-
                        Group participants (only present when
                        getParticipants=true).
                      items:
                        type: object
                        properties:
                          id:
                            type: string
                            description: Participant JID.
                          admin:
                            type:
                              - string
                              - 'null'
                            enum:
                              - superadmin
                              - admin
                              - null
                            description: >-
                              Admin role: 'superadmin', 'admin', or null for a
                              regular member.
              example:
                - id: 120363021234567890@g.us
                  subject: Equipe Pilot Status
                  subjectOwner: 5511999999999@s.whatsapp.net
                  subjectTime: 1720545600
                  pictureUrl: >-
                    https://pps.whatsapp.net/v/t61.24694-24/group_120363021234567890.jpg
                  size: 3
                  creation: 1720545600
                  owner: 5511999999999@s.whatsapp.net
                  desc: Grupo oficial da equipe.
                  descId: BAE5A1B2C3D4E5F6
                  restrict: false
                  announce: false
                  isCommunity: false
                  isCommunityAnnounce: false
                  linkedParent: null
                  participants:
                    - id: 5511999999999@s.whatsapp.net
                      admin: superadmin
                    - id: 5511988888888@s.whatsapp.net
                      admin: null
                - id: 120363049876543210@g.us
                  subject: Suporte
                  subjectOwner: 5511988888888@s.whatsapp.net
                  subjectTime: 1720459200
                  pictureUrl: null
                  size: 2
                  creation: 1720459200
                  owner: 5511988888888@s.whatsapp.net
                  desc: Canal de suporte interno.
                  descId: BAE5F6E5D4C3B2A1
                  restrict: true
                  announce: false
                  isCommunity: false
                  isCommunityAnnounce: false
                  linkedParent: null
        default:
          description: Error — provider or layer error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                  error:
                    type: string
                  message:
                    type: string
                  response:
                    type: object
              example:
                status: 400
                error: Bad Request
                message: Invalid payload
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: apikey
      description: >-
        Your Pilot Status API key (ps_...). Evolution GO also accepts
        `Authorization: Bearer <key>`.

````