Skip to main content
GET
/
instance
/
list
List WhatsApp Instances
curl --request GET \
  --url https://app.wachat.net/api/v1/instance/list \
  --header 'Authorization: Bearer <token>'
{
  "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/v/t61.24694-24/example.jpg",
      "profilePicUrl": "https://pps.whatsapp.net/v/t61.24694-24/example.jpg",
      "owner": "628123456789@s.whatsapp.net",
      "integration": "WHATSAPP-BAILEYS",
      "createdAt": "2026-06-13T08:00:00.000Z",
      "updatedAt": "2026-06-13T08:00:00.000Z"
    }
  ]
}
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. 
{
  "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"
    }
  ]
}
instanceName is the display name shown in Wachat. Use apiInstanceName for API calls such as state, logout, delete, send message, and profile picture.

Authorizations

​
Authorization
string
header
required

Authenticate your integration payloads by injecting your premium secure Wachat Account API Private Secret Key inside standard Authorization Bearer header vectors.

Response

Instance list returned successfully.

​
success
boolean
Example:

true

​
count
integer
Example:

1

​
instances
object[]