Skip to main content
GET
/
api
/
v1
/
client
/
info
Get client information
curl --request GET \
  --url http://localhost:{port}/api/v1/client/info \
  --header 'Authorization: Bearer <token>'
{
  "wid": "<string>",
  "platform": "<string>",
  "connected": true,
  "version": "<string>",
  "state": "INITIALIZING",
  "batteryPercentage": 123,
  "isCharged": true,
  "isPlugged": true
}

Authorizations

​
Authorization
string
header
required

JWT token authentication

Response

200 - application/json

Client information retrieved successfully

​
wid
string
required

WhatsApp ID of the client

​
platform
string
required

Platform information

​
connected
boolean
required

Whether the client is connected

​
version
string
required

Client version

​
state
enum<string>

Current state of the client

Available options:
INITIALIZING,
CONNECTING,
CONNECTED,
READY,
DISCONNECTED,
AUTHENTICATING,
AUTHENTICATION_FAILURE
​
batteryPercentage
number

Battery percentage (mobile clients)

​
isCharged
boolean

Whether the device is charged (mobile clients)

​
isPlugged
boolean

Whether the device is plugged in (mobile clients)