Fetch the public display photo (DP) of a WhatsApp user. Two-step flow: first call Check WhatsApp Account Exists (by Full Number) to obtain a userHash for the target number, then pass that userHash here. Calls without a valid (or expired/unknown) userHash are rejected. The number is resolved from the userHash server-side — no phone parameter is accepted. If the number is registered but the user has no photo or hides it by privacy, pictureSet=false and reason explains why. When pictureSet=true, the response includes the temporary photo URL and a picture version id that changes when the photo changes.

API Features

Profile photo retrieval Get the public display photo URL for a WhatsApp user resolved from the userHash

Gateway-validated userHash A valid, unexpired userHash is required for this lookup

Privacy-aware Clear pictureSet flag and reason when the photo is hidden by privacy or not set

Live API Demo

GET /api/project/whatsapp/get-avatar

API Response (JSON)

{}

curl -X GET 'https://api.opendata-api.com/api/project/whatsapp/get-avatar?key=<API_KEY>&userHash=<userHash>'

curl -X GET 'https://api.opendata-api.com/api/project/whatsapp/get-avatar?key=<API_KEY>&userHash=<userHash>'

📢

Need Help?

If you encounter API issues or need other API requirements, please contact us.

Use Cases

Enrich CRM contacts with WhatsApp profile photos
Show profile pictures in support or sales tools before a conversation
Detect avatar changes using the returned picture version id

Related operations

Guides

View Subscription Plans →

Get Profile Avatar (Display Photo)