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

# Get instance details

> Returns full details of a specific instance including connection status, phone number, and configuration. The instance must belong to the authenticated user.



## OpenAPI

````yaml openapi.json get /api/instances/{id}
openapi: 3.0.0
info:
  title: Wappfy API
  description: >-
    WhatsApp API Platform — Manage instances, send messages, and build
    integrations.
  version: '1.0'
  contact: {}
servers:
  - url: https://api.wappfy.io
    description: Production
security: []
tags:
  - name: Instances
    description: Create, connect, and manage WhatsApp instances (WAHA or Cloud API)
  - name: Messages
    description: >-
      Send messages via WhatsApp (text, media, location, poll, contacts, and
      more)
  - name: Chats
    description: List chats, read messages, mark as seen, and manage typing indicators
  - name: Groups
    description: Create and manage WhatsApp groups, participants, and invite links
  - name: Contacts
    description: Look up contacts, check phone numbers, and fetch profile pictures
  - name: Labels
    description: Organize chats with WhatsApp Business labels
  - name: Channels
    description: Create and manage WhatsApp Channels (newsletters)
  - name: Status
    description: Publish text status/stories
  - name: Presence
    description: Set and get online/offline presence
  - name: Webhooks
    description: Configure webhook endpoints to receive real-time event notifications
  - name: Admin
    description: >-
      Platform administration — user management, statistics, and proxy
      monitoring (admin only)
paths:
  /api/instances/{id}:
    get:
      tags:
        - Instances
      summary: Get instance details
      description: >-
        Returns full details of a specific instance including connection status,
        phone number, and configuration. The instance must belong to the
        authenticated user.
      operationId: InstancesController_findOne
      parameters:
        - name: id
          required: true
          in: path
          description: Instance ID
          schema:
            format: uuid
            type: string
      responses:
        '200':
          description: Instance details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstanceResponseDto'
        '401':
          description: Missing or invalid authentication token
        '403':
          description: Insufficient permissions
        '404':
          description: Instance not found
        '500':
          description: Internal server error
      security:
        - bearer: []
components:
  schemas:
    InstanceResponseDto:
      type: object
      properties:
        id:
          type: string
        user_id:
          type: string
        name:
          type: string
        instance_type:
          type: string
          enum:
            - waha
            - cloud_api
        status:
          type: string
          enum:
            - created
            - starting
            - scan_qr
            - connected
            - disconnected
            - failed
        phone_number:
          type: string
        display_name:
          type: string
          description: WhatsApp display name (pushName)
        session_name:
          type: string
        phone_number_id:
          type: string
        waba_id:
          type: string
        access_token:
          type: string
        webhook_url:
          type: string
        profile_picture_url:
          type: string
        is_active:
          type: boolean
        created_at:
          type: string
        updated_at:
          type: string
      required:
        - id
        - user_id
        - name
        - instance_type
        - status
        - is_active
        - created_at
        - updated_at
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http

````