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

# Get inbox by ID

> Returns the full data of a specific inbox



## OpenAPI

````yaml /en/openapi.json get /v1/inboxes/{id}
openapi: 3.0.0
info:
  title: Nuvia API - Company
  description: API documentation for companies
  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: Get inbox by ID
      description: Returns the full data of a specific inbox
      operationId: InboxController_findInbox
      parameters:
        - name: x-company-id
          in: header
          description: >-
            Target company identifier. Required only for global API keys
            (type=global). Ignored for company API keys and human users.
          required: false
          schema:
            type: string
        - name: id
          required: true
          in: path
          description: Inbox ID
          schema:
            type: string
      responses:
        '200':
          description: Inbox found successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InboxResponseDto'
        '401':
          description: Invalid or expired token
        '403':
          description: You do not have permission to access this resource
        '404':
          description: Resource not found
      security:
        - JWT-auth: []
components:
  schemas:
    InboxResponseDto:
      type: object
      properties:
        _id:
          description: Inbox ID
          type: string
        name:
          type: string
          description: Inbox name
        number:
          type: string
          description: Inbox's phone number
        webhook_url:
          description: Webhook URL for notifications
          type: string
        test_mode:
          description: Test mode settings
          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: Company that owns the inbox
        default_agent:
          description: Default agent for new conversations
        channel:
          type: string
          description: Communication channel (WAP_AUTO_CLOSER, etc.)
        status:
          type: string
          enum:
            - ACTIVE
            - DELETED
          description: Inbox status (ACTIVE, DELETED)
        api_wap_config:
          description: WhatsApp Business API settings (channel only)
          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: Evolution API settings
          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: LinkedIn settings (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: General inbox settings
          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: Enables ingestion of smb_message_echoes (WhatsApp Coexistence).
          type: boolean
        process_unsupported_messages:
          description: >-
            Allows UNSUPPORTED messages from Meta to follow the agent's normal
            flow.
          type: boolean
        disable_inbound_ai:
          description: >-
            Opt-in. When true, the AI does not handle organic inbound (new
            conversations for human handling); the AI keeps handling campaign
            leads.
          type: boolean
        pdf_local_text_extraction:
          type: boolean
          description: >-
            Opt-in for the hybrid PDF reading mode. When true, the text is
            extracted locally and the AI receives the TEXT instead of the image
            (it stays in the loop, just reorganizing it): no size limit and no
            vision tokens. Falls back to the vision path when local reading
            doesn't work (scanned PDF, non-PDF, unreadable). Default false.
        default_owner:
          description: >-
            ID of the default owner user for new conversations in this inbox
            (opt-in). Null = no default owner.
          type: string
          nullable: true
        createdAt:
          description: Inbox creation date
        updatedAt:
          description: Inbox update date
      required:
        - name
        - number
        - company
        - channel
        - status
  securitySchemes:
    JWT-auth:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: Token JWT de autenticação

````