Get Contact Profile

Retrieve detailed profile information for a WhatsApp contact.

POST /chat/fetchProfile/:instanceName

cURL

curl --request POST \
  --url https://api.example.com/chat/fetchProfile/my-instance \
  --header 'apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "number": "5511999999999"
  }'

const response = await fetch(
  'https://api.example.com/chat/fetchProfile/my-instance',
  {
    method: 'POST',
    headers: {
      'apikey': 'YOUR_API_KEY',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      number: '5511999999999'
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://api.example.com/chat/fetchProfile/my-instance',
    headers={
        'apikey': 'YOUR_API_KEY',
        'Content-Type': 'application/json'
    },
    json={
        'number': '5511999999999'
    }
)

data = response.json()

200 Success (Individual)

{
  "wid": "[e-mail]",
  "name": "John Doe",
  "status": "Available",
  "isBusiness": false,
  "profilePictureUrl": "https://example.com/profile-john.jpg"
}

{
  "wid": "[e-mail]",
  "name": "Acme Corporation",
  "status": "We're here to help!",
  "isBusiness": true,
  "profilePictureUrl": "https://example.com/profile-acme.jpg",
  "businessProfile": {
    "email": "[e-mail]",
    "description": "Leading provider of quality products",
    "website": ["https://acme.com", "https://shop.acme.com"],
    "address": "123 Business St, City, State 12345",
    "vertical": "Retail"
  }
}

{
  "error": "Invalid request",
  "message": "Number is required"
}

{
  "error": "Unauthorized",
  "message": "Invalid API key"
}

{
  "error": "Profile not found",
  "message": "The specified number is not registered on WhatsApp"
}

Overview

You can fetch detailed profile information for any WhatsApp contact, including their status, profile picture, and business profile details if applicable.

This endpoint works for both individual contacts and business accounts.

Authentication

This endpoint requires authentication via the apikey header.

header.apikey · string · required

Your Evolution API key for authentication.

Path Parameters

path.instanceName · string · required

The name of your WhatsApp instance.

Request Body

number · string · required

The phone number in international format without the ’+’ sign (e.g., “5511999999999”).

Response

wid · string

WhatsApp ID of the contact.

name · string

Contact’s display name.

status · string

Contact’s WhatsApp status/about text.

isBusiness · boolean

Whether this is a business account.

profilePictureUrl · string

URL of the contact’s profile picture.

businessProfile · object

Business profile information (only present for business accounts).

Show properties

email · string

Business email address.

description · string

Business description.

website · string[]

Array of business website URLs.

address · string

Business physical address.

vertical · string

Business category/industry.

cURL

curl --request POST \
  --url https://api.example.com/chat/fetchProfile/my-instance \
  --header 'apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "number": "5511999999999"
  }'

const response = await fetch(
  'https://api.example.com/chat/fetchProfile/my-instance',
  {
    method: 'POST',
    headers: {
      'apikey': 'YOUR_API_KEY',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      number: '5511999999999'
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://api.example.com/chat/fetchProfile/my-instance',
    headers={
        'apikey': 'YOUR_API_KEY',
        'Content-Type': 'application/json'
    },
    json={
        'number': '5511999999999'
    }
)

data = response.json()

200 Success (Individual)

{
  "wid": "[e-mail]",
  "name": "John Doe",
  "status": "Available",
  "isBusiness": false,
  "profilePictureUrl": "https://example.com/profile-john.jpg"
}

{
  "wid": "[e-mail]",
  "name": "Acme Corporation",
  "status": "We're here to help!",
  "isBusiness": true,
  "profilePictureUrl": "https://example.com/profile-acme.jpg",
  "businessProfile": {
    "email": "[e-mail]",
    "description": "Leading provider of quality products",
    "website": ["https://acme.com", "https://shop.acme.com"],
    "address": "123 Business St, City, State 12345",
    "vertical": "Retail"
  }
}

{
  "error": "Invalid request",
  "message": "Number is required"
}

{
  "error": "Unauthorized",
  "message": "Invalid API key"
}

{
  "error": "Profile not found",
  "message": "The specified number is not registered on WhatsApp"
}

Usage Notes

The contact’s status is their WhatsApp “About” text, which they can customize in their settings.

Use this endpoint to verify if a number is registered on WhatsApp before sending messages.

Business profile information is only available for WhatsApp Business accounts.

Related Endpoints

Fetch Profile Picture

To get only the profile picture URL:

POST /chat/fetchProfilePictureUrl/:instanceName

Request body:

{
  "number": "5511999999999"
}

Fetch Business Profile

To get detailed business profile information:

POST /chat/fetchBusinessProfile/:instanceName

Request body:

{
  "number": "5511888888888"
}

Check WhatsApp Number

To check if numbers are registered on WhatsApp:

POST /chat/whatsappNumbers/:instanceName

Request body:

{
  "numbers": ["5511999999999", "5511888888888"]
}

Returns an array indicating which numbers exist on WhatsApp.