Skip to main content
GET
/
instance
/
state
Get Instance State
curl --request GET \
  --url https://app.wachat.net/api/v1/instance/state \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "instance": {
      "instanceName": "t1_mq9r2jov_jakarta_store",
      "state": "open"
    }
  },
  "instance": {
    "instanceName": "jakarta_store",
    "apiInstanceName": "t1_mq9r2jov_jakarta_store",
    "internalName": "t1_mq9r2jov_jakarta_store",
    "state": "open",
    "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",
    "number": "628123456789",
    "owner": "628123456789@s.whatsapp.net",
    "integration": "WHATSAPP-BAILEYS"
  }
}
Check whether a WhatsApp instance is connected. When the instance is already connected, the response also includes the detected WhatsApp number and profile fields when they are available. Use the unique API instance name in the instanceName query parameter. In the normalized response, instance.instanceName is the display name shown in Wachat, while instance.apiInstanceName is the unique name you should keep using for API calls. 
{
  "success": true,
  "data": {
    "instance": {
      "instanceName": "jakarta_store",
      "state": "open"
    }
  },
  "instance": {
    "instanceName": "jakarta_store",
    "apiInstanceName": "t1_mqc3zame_jakarta_store",
    "internalName": "t1_mqc3zame_jakarta_store",
    "state": "open",
    "profileName": "jakarta_store",
    "profilePictureUrl": "https://pps.whatsapp.net/...",
    "profilePicUrl": "https://pps.whatsapp.net/...",
    "number": "628123456789",
    "owner": "628123456789@s.whatsapp.net",
    "integration": "WHATSAPP-BAILEYS"
  }
}
If WhatsApp returns the internal API instance name as the profile name, Wachat normalizes it back to the display name so your UI can show a clean name such as jakarta_store.
profilePictureUrl may be null if WhatsApp does not return a public profile photo for the connected account. For browser image rendering, use the Profile Picture endpoint instead of loading the WhatsApp URL directly.

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.

Query Parameters

​
instanceName
string
required

Unique API instance name returned by Wachat. Use apiInstanceName from the create or state response.

Response

Instance state returned successfully.

​
success
boolean
Example:

true

​
data
object

Raw state payload returned by Wachat. This may contain the internal API instance name.

​
instance
object

Normalized instance state and profile data for UI and API usage.