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

# Consultar inbox por ID

> Devuelve los datos completos de un inbox específico



## OpenAPI

````yaml /es/openapi.json get /v1/inboxes/{id}
openapi: 3.0.0
info:
  title: Nuvia API - Empresa
  description: Documentación de la API para empresas
  version: '1.0'
  contact: {}
servers:
  - url: https://api.nuvia.ai
security: []
tags:
  - name: messages
    x-group: Mensagens
  - name: contacts
    x-group: Contatos
  - name: campaigns
    x-group: Campanhas
  - name: tables
    x-group: Tabelas e Listas
  - name: agents
    x-group: Agentes
  - name: conversations
    x-group: Conversas
  - name: inboxes
    x-group: Caixas de Entrada
  - name: knowledge
    x-group: Base de Conhecimento
  - name: Webhooks
    x-group: Webhooks
  - name: campaign-enrollments
    x-group: Inscrições em Campanha
  - name: custom-fields
    x-group: Campos Customizados
paths:
  /v1/inboxes/{id}:
    get:
      tags:
        - inboxes
      summary: Consultar inbox por ID
      description: Devuelve los datos completos de un inbox específico
      operationId: InboxController_findInbox
      parameters:
        - name: x-company-id
          in: header
          description: >-
            Identificador de la empresa objetivo. Obligatorio solo para API keys
            globales (type=global). Se ignora para API keys de empresa y
            usuarios humanos.
          required: false
          schema:
            type: string
        - name: id
          required: true
          in: path
          description: ID del inbox
          schema:
            type: string
      responses:
        '200':
          description: Inbox encontrado correctamente
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InboxResponseDto'
        '401':
          description: Token inválido o expirado
        '403':
          description: Sin permiso para acceder a este recurso
        '404':
          description: Recurso no encontrado
      security:
        - JWT-auth: []
components:
  schemas:
    InboxResponseDto:
      type: object
      properties:
        _id:
          description: ID del inbox
          type: string
        name:
          type: string
          description: Nombre del inbox
        number:
          type: string
          description: Número de teléfono del inbox
        webhook_url:
          description: URL del webhook para notificaciones
          type: string
        test_mode:
          description: Configuración del modo de prueba
          type: object
          properties:
            enabled:
              description: Se o modo de teste está ativado
              type: boolean
            test_numbers:
              description: Números de telefone para teste
              type: array
              items:
                type: string
          required:
            - enabled
            - test_numbers
        company:
          description: Empresa propietaria del inbox
        default_agent:
          description: Agente predeterminado para conversaciones nuevas
        channel:
          type: string
          description: Canal de comunicación (WAP_AUTO_CLOSER, etc.)
        status:
          type: string
          enum:
            - ACTIVE
            - DELETED
          description: Status del inbox (ACTIVE, DELETED)
        api_wap_config:
          description: Configuración de la API de WhatsApp Business (solo para el canal)
          type: object
          properties:
            phone_number_id:
              type: string
              description: ID do número de telefone no WhatsApp Business
            business_id:
              type: string
              description: ID do negócio no WhatsApp Business
            business_token:
              type: string
              description: Token de autenticação do negócio
            waba_id:
              type: string
              description: ID da conta WhatsApp Business
          required:
            - phone_number_id
            - business_id
            - business_token
            - waba_id
        evolution_api_config:
          description: Configuración de la Evolution API
          type: object
          properties:
            base_url:
              type: string
              description: URL base da Evolution API
            api_key:
              type: string
              description: Chave de API da Evolution
            instance_name:
              type: string
              description: Nome da instância na Evolution API
          required:
            - base_url
            - api_key
            - instance_name
        linkedin_config:
          description: Configuración de LinkedIn (Unipile)
          type: object
          properties:
            account_id:
              type: string
              description: Account ID do LinkedIn na Unipile
            provider:
              description: Provider do LinkedIn (Unipile)
              type: string
            display_name:
              description: Nome exibido da conta
              type: string
            profile_url:
              description: URL do perfil LinkedIn
              type: string
            public_identifier:
              description: Identificador público do perfil LinkedIn
              type: string
          required:
            - account_id
        general_config:
          type: object
          description: Configuración general del inbox
          properties:
            include_operator_name_on_message:
              type: boolean
              description: Se deve incluir o nome do operador nas mensagens
          required:
            - include_operator_name_on_message
        coexistence_enabled:
          description: Habilita la ingesta de smb_message_echoes (WhatsApp Coexistence).
          type: boolean
        process_unsupported_messages:
          description: >-
            Permite que los mensajes UNSUPPORTED de Meta sigan el flujo normal
            del agent.
          type: boolean
        disable_inbound_ai:
          description: >-
            Opt-in. Cuando es true, la IA no atiende inbound orgánico
            (conversaciones nuevas para atención humana); la IA sigue atendiendo
            leads de campaña.
          type: boolean
        pdf_local_text_extraction:
          type: boolean
          description: >-
            Habilitación (opt-in) del modo híbrido de lectura de PDF. Cuando es
            true, el texto se extrae localmente y la IA recibe el TEXTO en lugar
            de la imagen (sigue en el circuito, solo reorganiza): sin límite de
            tamaño y sin tokens de visión. Vuelve al camino de visión cuando la
            lectura local no sirve (PDF escaneado, no PDF, ilegible). Valor
            predeterminado: false.
        default_owner:
          description: >-
            ID del usuario propietario predeterminado de las conversaciones
            nuevas de este inbox (opt-in). Null = sin propietario
            predeterminado.
          type: string
          nullable: true
        createdAt:
          description: Fecha de creación del inbox
        updatedAt:
          description: Fecha de actualización del inbox
      required:
        - name
        - number
        - company
        - channel
        - status
  securitySchemes:
    JWT-auth:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: Token JWT de autenticação

````