> ## 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 groups

> Lists WhatsApp groups for the linked number (same instance as POST /api/v1/messages/send). Requires an OPEN instance (409 WHATSAPP_INSTANCE_NOT_CONNECTED if disconnected). With no linked instance returns { groups: [] }. NOT_SUPPORTED_FOR_META: Meta numbers return 400 NOT_SUPPORTED_FOR_META. Requires a number-scoped key.

**Requires a number-scoped key.**



## OpenAPI

````yaml openapi.json GET /v1/groups
openapi: 3.1.0
info:
  title: Pilot Status API
  version: 1.0.0
  license:
    name: Pilot Status Terms of Service
    url: https://pilotstatus.com.br/terms
  description: >-
    Public REST API for Pilot Status. Authenticate with the `x-api-key: ps_...`
    header (or `x-api-key-id`). Base URL: https://pilotstatus.com.br
servers:
  - url: https://pilotstatus.com.br
security:
  - apiKey: []
  - apiKeyId: []
paths:
  /v1/groups:
    get:
      tags:
        - Groups
      summary: List groups
      description: >-
        Lists WhatsApp groups for the linked number (same instance as POST
        /api/v1/messages/send). Requires an OPEN instance (409
        WHATSAPP_INSTANCE_NOT_CONNECTED if disconnected). With no linked
        instance returns { groups: [] }. NOT_SUPPORTED_FOR_META: Meta numbers
        return 400 NOT_SUPPORTED_FOR_META. Requires a number-scoped key.


        **Requires a number-scoped key.**
      operationId: get_groups
      responses:
        '200':
          description: List groups
          content:
            application/json:
              example:
                groups:
                  - id: 123456789-987654321@g.us
                    subject: Pilot Status Group
                    size: 12
        '400':
          description: Meta number (not supported)
          content:
            application/json:
              example:
                error: Groups are not supported for Meta Cloud API numbers
                code: NOT_SUPPORTED_FOR_META
        '401':
          description: Missing or invalid `x-api-key` / `x-api-key-id` header
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Unauthorized
        '403':
          description: Tenant-scoped key used on a number-scoped endpoint
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Tenant-scoped keys cannot call number endpoints
                code: TENANT_SCOPE_NOT_ALLOWED
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Too many requests
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Your ps_ API key
    apiKeyId:
      type: apiKey
      in: header
      name: x-api-key-id
      description: API key id (alternative to x-api-key)

````