Skip to main content
GET
/
user
/
info
Get User Info
curl --request GET \
  --url https://api.example.com/user/info \
  --header 'Authorization: <authorization>'
{
  "400": {},
  "500": {},
  "code": "<string>",
  "message": "<string>",
  "results": {
    "verified_name": "<string>",
    "status": "<string>",
    "picture_id": "<string>",
    "devices": [
      {
        "User": "<string>",
        "Agent": 123,
        "Device": "<string>",
        "Server": "<string>",
        "AD": true
      }
    ]
  }
}
Get comprehensive information about a WhatsApp user including their verified name, status, profile picture ID, and connected devices.

​
Authentication

​
Authorization
string
required
Basic authentication credentials (username:password in base64)

​
Headers

​
X-Device-Id
string
Device identifier for multi-device support. Required when multiple devices are registered. If only one device is registered, it will be used as the default.

​
Query Parameters

​
phone
string
required
Phone number with WhatsApp suffix formatExample: [email protected]

​
Response

​
code
string
Response code indicating success or failureExample: SUCCESS
​
message
string
Human-readable response messageExample: Success
​
results
object
User information data
​
verified_name
string
User’s verified name on WhatsAppExample: Aldino Kemal
​
status
string
User’s WhatsApp status/about textExample: Hello World
​
picture_id
string
Unique identifier for the user’s profile pictureExample: 1651459152
​
devices
array
List of devices linked to this WhatsApp account
​
User
string
User’s phone numberExample: 6289685021291
​
Agent
integer
Agent identifierExample: 0
​
Device
string
Device typeExample: UNKNOWN
​
Server
string
WhatsApp server addressExample: s.whatsapp.net
​
AD
boolean
Whether this is an AD (Authenticated Device)Example: true

​
Example Request

curl -X GET 'http://localhost:3000/user/[email protected]' \
  -u 'username:password' \
  -H 'X-Device-Id: my-device-id'

​
Response Example

{
  "code": "SUCCESS",
  "message": "Success",
  "results": {
    "verified_name": "Aldino Kemal",
    "status": "Hello World",
    "picture_id": "1651459152",
    "devices": [
      {
        "User": "6289685021291",
        "Agent": 0,
        "Device": "UNKNOWN",
        "Server": "s.whatsapp.net",
        "AD": true
      }
    ]
  }
}

​
Error Responses

​
400
object
Bad Request
{
  "code": "400",
  "message": "phone field cannot be blank",
  "results": null
}
​
500
object
Internal Server Error
{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Failed to fetch user info",
  "results": null
}

​
Usage Notes

  • The phone parameter must include the WhatsApp suffix @s.whatsapp.net
  • For group JIDs, use @g.us suffix instead
  • The picture_id can be used to check if a user has changed their profile picture
  • The devices array shows all linked devices for the user account
  • Some fields may be empty if the user has privacy settings enabled

Build docs developers (and LLMs) love

Get started for freeTalk to us