v1

latestOpenAPI 3.1.02026-07-1413113265.9 KB
client

retrieve basic client information

Retrieve general information of the user connected to your instance.

get/instances/{id}/client/me

Path parameters

idinteger required

Instance ID

Response

The connected client information

status'success' | 'error'

Example response

{
  "me": {
    "status": "success",
    "instanceId": "1",
    "data": {
      "displayName": "Username",
      "contactId": "<xxxxx>@c.us",
      "formattedNumber": "+xx xx xxx xx xx",
      "profilePicUrl": "https://pps.link.net/v/<profileImageUrl>"
    }
  },
  "links": {
    "self": "https://waapi.app/api/v1/instances/1/client/me"
  },
  "status": "success"
}