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

# Consultar conexão WhatsApp

> Consulta os detalhes de uma conta WhatsApp conectada.



## OpenAPI

````yaml /whatsapp-api/api-reference/openapi-whatsapp.json get /v1/whatsapp/instances/{instanceId}
openapi: 3.0.3
info:
  title: Notifique API — WhatsApp
  description: >-
    Envie mensagens WhatsApp e gerencie conexões. Autentique com `Authorization:
    Bearer sk_live_...` ou `x-api-key`.
  version: 1.0.0
servers:
  - url: https://api.notifique.dev
    description: Produção
security:
  - ntfWaBearerAuth: []
  - ntfWaApiKeyHeader: []
tags:
  - name: Mensagens
    description: Enviar, listar, editar e cancelar mensagens
  - name: Instâncias
    description: >-
      Cadastre e gerencie os números de WhatsApp conectados — cada número é uma
      **instância** (o telefone por onde entram e saem as mensagens).
  - name: Grupos
    description: Grupos (só conexão não oficial)
paths:
  /v1/whatsapp/instances/{instanceId}:
    get:
      tags:
        - Instâncias
      summary: Consultar conexão WhatsApp
      description: Consulta os detalhes de uma conta WhatsApp conectada.
      operationId: ntfWa_getV1WhatsappInstance
      parameters:
        - name: instanceId
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Dados da instância.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfWa_InstanceResponse'
              example:
                success: true
                data:
                  id: inst_abc
                  name: Suporte
                  status: ACTIVE
                  phoneNumber: '5511999999999'
                  mode: OFFICIAL
                  whatsappOfficialCloud: true
                  createdAt: '2026-07-20T12:00:00.000Z'
        '401':
          description: Não autorizado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfWa_ErrorResponse'
        '402':
          description: Plano expirado ou suspenso.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfWa_ErrorResponse'
        '403':
          description: Escopo ou acesso à instância negado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfWa_ErrorResponse'
        '404':
          description: Instância não encontrada.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfWa_ErrorResponse'
components:
  schemas:
    NtfWa_InstanceResponse:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          type: object
          properties:
            id:
              type: string
            name:
              type: string
            phoneNumber:
              type: string
              nullable: true
            expectedPhoneNumber:
              type: string
              nullable: true
              description: Número esperado informado na criação (conexão não oficial).
            lockedPhoneNumber:
              type: string
              nullable: true
              description: >-
                Número permanentemente vinculado após o primeiro pareamento
                (conexão não oficial).
            reconnectBlockedUntil:
              type: string
              format: date-time
              nullable: true
              description: >-
                Até quando a reconexão fica bloqueada após desconexão
                involuntária.
            firstConnectedAt:
              type: string
              format: date-time
              nullable: true
              description: Data/hora da primeira conexão bem-sucedida (base do warm-up).
            warmup:
              $ref: '#/components/schemas/NtfWa_WarmupSnapshot'
            status:
              type: string
            createdAt:
              type: string
              format: date-time
            updatedAt:
              type: string
              format: date-time
    NtfWa_ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
          description: 'Rótulo HTTP do erro (ex.: Unauthorized, Bad Request, Not Found).'
        message:
          type: string
          description: >-
            Mensagem legível para exibir ao usuário (localizada via
            Accept-Language / x-locale quando aplicável).
        code:
          type: string
          description: >-
            Código estável da API v1 (enum). Sempre presente em erros. Use com o
            status HTTP para decidir retry ou correção. Ver [Respostas de
            erro](/guides/conceitos/resposta-de-erros).
        details:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
              message:
                type: string
        note:
          type: string
      required:
        - success
        - error
        - message
        - code
    NtfWa_WarmupSnapshot:
      type: object
      description: >-
        Estado do warm-up da instância (conexão não oficial, primeiros 3 dias
        após firstConnectedAt).
      properties:
        active:
          type: boolean
          description: Se a instância está em warm-up.
        dailyLimit:
          type: integer
          description: Limite diário de envios durante warm-up (20).
        sentToday:
          type: integer
          description: Envios já contabilizados hoje (UTC).
        daysRemaining:
          type: integer
          description: Dias restantes na janela de warm-up.
  securitySchemes:
    ntfWaBearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        API Key no header Authorization. Exemplo: `Authorization: Bearer
        sk_live_xxxxx`
    ntfWaApiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key
      description: API Key no header x-api-key.

````