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

# List Instances

> Return all WhatsApp instances that belong to the authenticated Wachat account, including display name, API instance name, connection status, number, and profile data when available.

Return all WhatsApp instances that belong to the authenticated Wachat account.

Use this endpoint when your external application needs to show available instances, connection status, profile data, and the `apiInstanceName` required for future API calls.

```json theme={null}
{
  "success": true,
  "count": 1,
  "instances": [
    {
      "id": 29,
      "instanceName": "jakarta_store",
      "displayName": "jakarta_store",
      "apiInstanceName": "t1_mq9r2jov_jakarta_store",
      "internalName": "t1_mq9r2jov_jakarta_store",
      "state": "open",
      "status": "open",
      "isConnected": true,
      "number": "628123456789",
      "profileName": "jakarta_store",
      "profilePictureUrl": "https://pps.whatsapp.net/...",
      "profilePicUrl": "https://pps.whatsapp.net/...",
      "owner": "628123456789@s.whatsapp.net",
      "integration": "WHATSAPP-BAILEYS",
      "createdAt": "2026-06-13T08:00:00.000Z",
      "updatedAt": "2026-06-13T08:00:00.000Z"
    }
  ]
}
```

<Note>
  `instanceName` is the display name shown in Wachat. Use `apiInstanceName` for API calls such as state, logout, delete, send message, and profile picture.
</Note>


## OpenAPI

````yaml GET /instance/list
openapi: 3.0.3
info:
  title: Wachat Enterprise API
  description: >
    Welcome to the official Wachat API reference. Wachat provides
    developer-friendly, ultra-reliable infrastructure to scale your WhatsApp
    communications programmatically.


    Easily deploy automated messaging pipelines, orchestrate interactive
    customer engagement patterns, verify phone numbers instantly, and control
    containerized WhatsApp instances via a secure, production-grade REST
    architecture.
  version: 1.0.0
servers:
  - url: https://app.wachat.net/api/v1
    description: Live Production Gateway
security:
  - bearerAuth: []
paths:
  /instance/list:
    get:
      tags:
        - Session Lifecycle Infrastructure
      summary: List WhatsApp Instances
      description: >-
        Return all WhatsApp instances that belong to the authenticated Wachat
        account, including display name, API instance name, connection status,
        number, and profile data when available.
      responses:
        '200':
          description: Instance list returned successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  count:
                    type: integer
                    example: 1
                  instances:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 29
                        instanceName:
                          type: string
                          description: Display name shown in Wachat.
                          example: jakarta_store
                        displayName:
                          type: string
                          description: Display name shown in Wachat.
                          example: jakarta_store
                        apiInstanceName:
                          type: string
                          description: Unique API instance name to use in future API calls.
                          example: t1_mq9r2jov_jakarta_store
                        internalName:
                          type: string
                          description: >-
                            Internal API instance name. Same value as
                            apiInstanceName.
                          example: t1_mq9r2jov_jakarta_store
                        state:
                          type: string
                          example: open
                        status:
                          type: string
                          example: open
                        isConnected:
                          type: boolean
                          example: true
                        number:
                          type: string
                          nullable: true
                          example: '628123456789'
                        profileName:
                          type: string
                          nullable: true
                          example: jakarta_store
                        profilePictureUrl:
                          type: string
                          nullable: true
                          example: https://pps.whatsapp.net/v/t61.24694-24/example.jpg
                        profilePicUrl:
                          type: string
                          nullable: true
                          description: Alias of profilePictureUrl.
                          example: https://pps.whatsapp.net/v/t61.24694-24/example.jpg
                        owner:
                          type: string
                          nullable: true
                          example: 628123456789@s.whatsapp.net
                        integration:
                          type: string
                          example: WHATSAPP-BAILEYS
                        createdAt:
                          type: string
                          format: date-time
                          example: '2026-06-13T08:00:00.000Z'
                        updatedAt:
                          type: string
                          format: date-time
                          example: '2026-06-13T08:00:00.000Z'
        '401':
          description: Missing or invalid API key.
        '403':
          description: Subscription restriction prevented instance list lookup.
        '500':
          description: Internal server error.
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Authenticate your integration payloads by injecting your premium secure
        Wachat Account API Private Secret Key inside standard Authorization
        Bearer header vectors.

````