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

> Lists every WhatsApp number on the tenant (PILOT_STATUS and Meta Cloud API), including connection state and API key prefixes. Authenticate with x-api-key-id (or x-api-key: ps_…).



## OpenAPI

````yaml openapi.json GET /v1/numbers
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/numbers:
    get:
      tags:
        - Numbers
      summary: List numbers
      description: >-
        Lists every WhatsApp number on the tenant (PILOT_STATUS and Meta Cloud
        API), including connection state and API key prefixes. Authenticate with
        x-api-key-id (or x-api-key: ps_…).
      operationId: get_numbers
      responses:
        '200':
          description: List numbers
          content:
            application/json:
              example:
                - id: num_01HZX...
                  instanceName: tenant-5511999999999
                  number: '5511999999999'
                  name: Suporte
                  provider: PILOT_STATUS
                  apiKeys:
                    - name: Default
                      keyPrefix: ps_abcd
                      keyLast4: wxyz
                  state: OPEN
                  isFullyConnected: true
                  createdAt: '2026-06-01T11:59:00.000Z'
                  updatedAt: '2026-06-01T12:00:00.000Z'
        '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
        '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)

````