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

> ## Agent Instructions
> Wabox é uma API não-oficial de WhatsApp (aparelho vinculado). Tudo é snake_case; a base é https://api.wabox.me/instances/{instance_id}/token/{token}.
> Envios respondem { id, message_id, wabox_id, status: "queued" } na hora; o resultado real chega no webhook delivery. Envios não são idempotentes: confira GET /queue antes de repetir.
> Sempre verifique X-Wabox-Signature (HMAC-SHA256 de "<t>.<corpo cru>") nos webhooks e deduplique por event_id.
> Botões, listas, carrossel e catálogo são best effort e não renderizam no WhatsApp Web/Desktop. Não existem: chamadas, listas de transmissão, histórico de mensagens, instância mobile.
> Não invente endpoints ou campos: use o OpenAPI em https://api.wabox.me/openapi.json.

# Listar instâncias

> Instâncias do workspace Partner, da mais recente para a mais antiga, com `token` e webhooks. Filtre por `status` (`connected` / `disconnected`) ou `q` (nome, id ou número).



## OpenAPI

````yaml /openapi.json get /partner/instances
openapi: 3.1.0
info:
  title: Wabox API
  description: >-
    API pública do Wabox — WhatsApp via REST + webhooks.


    Base: `{server}/instances/{instance_id}/token/{token}`. Header
    `Client-Token` obrigatório quando ativado em Segurança.


    Tudo em `snake_case`. Datas ISO-8601 (UTC). Erros: `{ "error": { "code":
    "...", "message": "..." } }`.


    Envios respondem `{ id, message_id, wabox_id, status: "queued" }` na hora; o
    resultado chega no webhook `delivery`. `message_id` já é o id definitivo do
    WhatsApp.
  version: '1.0'
  contact: {}
servers:
  - url: https://api.wabox.me
security: []
tags:
  - name: Instance
    description: >-
      Conexão (QR code / código de pareamento), status, webhooks e configurações
      da instância.
    x-group: Instância
  - name: Messages
    description: >-
      Envio de texto, mídia, localização, contatos, reações, enquetes e ações
      sobre mensagens. Tudo passa pela fila; o resultado chega no webhook
      `delivery`.
    x-group: Mensagens
  - name: Interactive
    description: >-
      Botões, listas, carrossel, PIX, eventos de calendário, status (stories) e
      convite de canal. Best effort: renderizam no celular; o WhatsApp
      Web/Desktop não exibe botões, listas nem carrossel.
    x-group: Interativos
  - name: Queue
    description: Mensagens aguardando envio (pacing anti-ban ou instância desconectada).
    x-group: Fila
  - name: Chats
    description: >-
      Lista de conversas, ações (arquivar, silenciar, fixar, ler) e mensagens
      temporárias.
    x-group: Chats
  - name: Contacts
    description: Contatos, foto de perfil, verificação de números e bloqueio.
    x-group: Contatos
  - name: Profile
    description: Nome, recado e foto do número conectado.
    x-group: Perfil
  - name: Groups
    description: >-
      Criar, listar, administrar participantes, links de convite e
      configurações.
    x-group: Grupos
  - name: Communities
    description: Comunidades e vínculo de grupos.
    x-group: Comunidades
  - name: Newsletters
    description: >-
      Canais (newsletters): criar, seguir, ler e reagir a posts. Para publicar,
      use qualquer `send-*` com `phone: <id>@newsletter`.
    x-group: Canais
  - name: Privacy
    description: Configurações de privacidade da conta.
    x-group: Privacidade
  - name: Business
    description: >-
      Perfil comercial, catálogo de produtos, pedidos e envio de
      produto/catálogo/pedido. Best effort: depende do protocolo do WhatsApp
      Web.
    x-group: Business e catálogo
  - name: Labels
    description: Etiquetas (labels) de conversas — só em contas WhatsApp Business.
    x-group: Etiquetas
  - name: Partner
    description: >-
      Para integradores: criar e administrar instâncias do próprio workspace
      Partner com o header `Partner-Token` (base `/partner`, sem
      `instance_id`/`token` na URL). As instâncias criadas aqui são operadas
      pela API pública normal e não têm trial nem `402`.
    x-group: Partner
  - name: Webhooks
    description: Eventos entregues por `POST` na URL configurada em cada instância.
    x-group: Webhooks
paths:
  /partner/instances:
    get:
      tags:
        - Partner
      summary: Listar instâncias
      description: >-
        Instâncias do workspace Partner, da mais recente para a mais antiga, com
        `token` e webhooks. Filtre por `status` (`connected` / `disconnected`)
        ou `q` (nome, id ou número).
      operationId: partnerInstances.list
      parameters:
        - name: page_size
          required: false
          in: query
          description: 1–100. Padrão 20.
          schema:
            example: 20
        - name: page
          required: false
          in: query
          schema:
            example: 1
        - name: q
          required: false
          in: query
          description: Busca por nome, id ou número.
          schema: {}
        - name: status
          required: false
          in: query
          schema:
            enum:
              - connected
              - disconnected
            type: string
      responses:
        '200':
          description: Página de instâncias.
          content:
            application/json:
              example:
                data:
                  - id: 8f2a3c1e-6b7d-4e5f-9a0b-1c2d3e4f5a6b
                    name: Loja Centro
                    token: 3A1F5C7E9B2D4F6A8C0E1B3D5F7A9C2E
                    status: qr
                    status_reason: null
                    connected: false
                    phone: null
                    profile_name: null
                    platform: null
                    connected_at: null
                    disconnected_at: null
                    subscription_status: partner
                    trial_ends_at: '2026-09-15T12:00:00.000Z'
                    due_at: null
                    settings:
                      auto_read_message: false
                      auto_read_status: false
                      call_reject_auto: false
                      call_reject_message: null
                      disable_enqueue_when_disconnected: false
                      delay_message_min_ms: 1000
                      delay_message_max_ms: 3000
                      proxy_url: null
                    webhooks:
                      received_url: https://kinbox.example/wabox/received
                      delivery_url: https://kinbox.example/wabox/delivery
                      message_status_url: https://kinbox.example/wabox/status
                      connected_url: https://kinbox.example/wabox/connected
                      disconnected_url: https://kinbox.example/wabox/disconnected
                      chat_presence_url: null
                      notify_sent_by_me: true
                      ignore_groups: false
                      ignore_private: false
                      ignore_text: false
                      ignore_image: false
                      ignore_video: false
                      ignore_audio: false
                      ignore_document: false
                      ignore_received_callback: false
                      ignore_delivery_callback: false
                      ignore_message_status_callback: false
                      ignore_connected_callback: false
                      ignore_disconnected_callback: false
                      ignore_chat_presence_callback: false
                      secret: whsec_9f8e7d6c5b4a39281706f5e4d3c2b1a0
                    api_url: >-
                      https://api.wabox.me/instances/8f2a3c1e-6b7d-4e5f-9a0b-1c2d3e4f5a6b/token/3A1F5C7E9B2D4F6A8C0E1B3D5F7A9C2E
                    created_at: '2026-09-15T12:00:00.000Z'
                    updated_at: '2026-09-15T12:00:00.000Z'
                page: 1
                page_size: 20
                total: 1
        '401':
          description: '`Partner-Token` ausente ou inválido.'
          content:
            application/json:
              example:
                error:
                  code: partner_token_required
                  message: Invalid Partner-Token
      security:
        - PartnerToken: []
components:
  securitySchemes:
    PartnerToken:
      type: apiKey
      in: header
      name: Partner-Token
      description: >-
        Credencial da Partner API (workspace › Segurança › Partner API). Só nas
        rotas `/partner/*`.

````