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

# Dados da instância

> Retorna metadados da instância, webhooks configurados e ajustes operacionais.

Retorna metadados da instância, webhooks configurados e ajustes operacionais.


## OpenAPI

````yaml GET /instances/{instanceId}/token/{instanceToken}/me
openapi: 3.0.3
info:
  title: EZ API
  version: 1.0.0
  description: >-
    Documentação pública reconstruída a partir da collection WA Gateway e
    validada contra os endpoints públicos existentes da EZ API.
servers:
  - url: https://api.ezapi.com.br
    description: Produção
  - url: http://localhost:3000
    description: Desenvolvimento local
security:
  - ClientToken: []
tags:
  - name: Instância
    description: >-
      Crie, conecte, monitore e ajuste o comportamento da sua instância do
      WhatsApp.
  - name: Mensagens
    description: >-
      Envie mensagens assíncronas em texto, mídia, interativos e recursos
      avançados.
  - name: Conversas
    description: Endpoints de conversas.
  - name: Contatos
    description: Endpoints de contatos.
  - name: Privacidade
    description: Endpoints de privacidade.
  - name: Grupos
    description: >-
      Crie grupos, gerencie participantes, convites, foto, descrição e
      permissões.
  - name: Status
    description: Endpoints de status.
  - name: Fila de mensagens
    description: Endpoints de fila de mensagens.
  - name: WhatsApp Business
    description: Endpoints de whatsapp business.
  - name: Webhooks
    description: Configure URLs HTTPS para receber eventos em tempo real da EZ API.
paths:
  /instances/{instanceId}/token/{instanceToken}/me:
    get:
      tags:
        - Instância
      summary: Dados da instância
      description: >-
        Retorna metadados da instância, webhooks configurados e ajustes
        operacionais.
      operationId: instance_me
      parameters:
        - name: instanceId
          in: path
          required: true
          description: Identificador único da instância.
          schema:
            type: string
            example: abc1234567890
        - name: instanceToken
          in: path
          required: true
          description: Token privado da instância retornado na criação.
          schema:
            type: string
            example: tok_a1b2c3d4e5f6
      responses:
        '200':
          description: Resposta de sucesso.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    example: abc1234567890
                  name:
                    type: string
                    example: Minha Instância
                  connected:
                    type: boolean
                    example: true
                  phone:
                    type: string
                    example: '5511999999999'
                  receivedCallbackUrl:
                    type: string
                    example: https://example.com/webhooks/received
                  deliveryCallbackUrl:
                    type: string
                    example: https://example.com/webhooks/delivery
                  disconnectedCallbackUrl:
                    type: string
                    example: https://example.com/webhooks/disconnected
                  connectedCallbackUrl:
                    type: string
                    example: https://example.com/webhooks/connected
                  messageStatusCallbackUrl:
                    type: string
                    example: https://example.com/webhooks/status
                  presenceChatCallbackUrl:
                    type: string
                    example: https://example.com/webhooks/presence
                  receiveCallbackSentByMe:
                    type: boolean
                    example: false
                  callRejectAuto:
                    type: boolean
                    example: false
                  callRejectMessage:
                    type: string
                    example: ''
                  autoReadMessage:
                    type: boolean
                    example: false
                  autoReadStatus:
                    type: boolean
                    example: false
                  disableQueueWhenDisconnected:
                    type: boolean
                    example: false
                required:
                  - id
                  - name
                  - connected
                  - phone
                  - receivedCallbackUrl
                  - deliveryCallbackUrl
                  - disconnectedCallbackUrl
                  - connectedCallbackUrl
                  - messageStatusCallbackUrl
                  - presenceChatCallbackUrl
                  - receiveCallbackSentByMe
                  - callRejectAuto
                  - callRejectMessage
                  - autoReadMessage
                  - autoReadStatus
                  - disableQueueWhenDisconnected
                example:
                  id: abc1234567890
                  name: Minha Instância
                  connected: true
                  phone: '5511999999999'
                  receivedCallbackUrl: https://example.com/webhooks/received
                  deliveryCallbackUrl: https://example.com/webhooks/delivery
                  disconnectedCallbackUrl: https://example.com/webhooks/disconnected
                  connectedCallbackUrl: https://example.com/webhooks/connected
                  messageStatusCallbackUrl: https://example.com/webhooks/status
                  presenceChatCallbackUrl: https://example.com/webhooks/presence
                  receiveCallbackSentByMe: false
                  callRejectAuto: false
                  callRejectMessage: ''
                  autoReadMessage: false
                  autoReadStatus: false
                  disableQueueWhenDisconnected: false
              example:
                id: abc1234567890
                name: Minha Instância
                connected: true
                phone: '5511999999999'
                receivedCallbackUrl: https://example.com/webhooks/received
                deliveryCallbackUrl: https://example.com/webhooks/delivery
                disconnectedCallbackUrl: https://example.com/webhooks/disconnected
                connectedCallbackUrl: https://example.com/webhooks/connected
                messageStatusCallbackUrl: https://example.com/webhooks/status
                presenceChatCallbackUrl: https://example.com/webhooks/presence
                receiveCallbackSentByMe: false
                callRejectAuto: false
                callRejectMessage: ''
                autoReadMessage: false
                autoReadStatus: false
                disableQueueWhenDisconnected: false
        '401':
          description: Client-Token ou instanceToken inválido
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
              example:
                error: Unauthorized
                message: Invalid instanceToken
        '404':
          description: Instância ou recurso não encontrado
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
              example:
                error: Instance not found
      security:
        - ClientToken: []
components:
  securitySchemes:
    ClientToken:
      type: apiKey
      in: header
      name: Client-Token

````