Contacts and Profile

Contact Details

Returns full details of a contact: name, photo, status, verification, e-commerce.

POSThttps://api.zapzapapi.com/api/v1/{instanceId}/chat/details

Authentication with the x-api-key and x-api-secret headers.

Parameters

NameTypeInRequiredDescription
numbertextbodyYesPhone number or group ID
previewselectbodyNoControls the size of the returned profile image: - `true`: Returns the image in preview size (smaller, optimized for listings) - `false` (default): Returns the image in full size (original resolution, higher quality)

Request example

curl

curl -X POST "https://api.zapzapapi.com/api/v1/{instanceId}/chat/details" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-api-secret: YOUR_API_SECRET" \
  -H "Content-Type: application/json" \
  -d '{"number":"5511999999999"}'

Node.js

const res = await fetch("https://api.zapzapapi.com/api/v1/{instanceId}/chat/details", {
  method: "POST",
  headers: {
    "x-api-key": "YOUR_API_KEY",
    "x-api-secret": "YOUR_API_SECRET",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "number": "5511999999999"
  }),
});
console.log(await res.json());

Python

import requests

res = requests.post(
    "https://api.zapzapapi.com/api/v1/{instanceId}/chat/details",
    headers={"x-api-key": "YOUR_API_KEY", "x-api-secret": "YOUR_API_SECRET"},
    json={"number":"5511999999999"},
)
print(res.json())

Response example

JSON

{
  "jid": "5511999999999@s.whatsapp.net",
  "name": "João",
  "pushName": "João Silva",
  "profilePicUrl": "https://..."
}

Values are illustrative; the fields follow the real response format.

See the full reference

Get your API keys

Create your account, connect a number in minutes and start using the API. R$15 per active number/month, with a welcome credit when you create the account, subject to the current campaign.