Skip to main content
GET
/
api
/
{session}
/
profile
Get my profile
curl --request GET \
  --url https://{host}/api/{session}/profile \
  --header 'apikey: <api-key>'
{
    "name": "John Silva",
    "status": "Available to chat",
    "picture": "https://..."
}

Documentation Index

Fetch the complete documentation index at: https://docs.wappfy.com.br/llms.txt

Use this file to discover all available pages before exploring further.

​
Description

This endpoint returns profile information of the user authenticated in the WhatsApp session, including display name, status (about/bio), and other profile information. ⚠️ This endpoint is not yet implemented.

​
URL Parameters

​
session
string
required
WhatsApp unique authenticated session ID

​
Expected Response

​
name
string
User profile display name
​
status
string
Profile status/about (not to be confused with Stories)
​
picture
string
User profile picture URL
{
    "name": "John Silva",
    "status": "Available to chat",
    "picture": "https://..."
}

​
Status Codes

  • 200 - Profile obtained successfully
  • 400 - Invalid parameters
  • 401 - Unauthorized
  • 501 - Not implemented

​
Usage Example

curl -X GET https://api.wappfy.com.br/api/my-session/profile

Authorizations

​
apikey
string
header
required

Your Wappfy API key (get it at dash.wappfy.com.br)

Path Parameters

​
session
string
required

The session name (instanceName) of the profile you want to get

Response

200 - application/json
​
id
string
required
Example:

"5511999999999@c.us"

​
picture
string | null
required
Example:

"https://example.com/picture.jpg"

​
name
string
required