Skip to main content
GET
/
instances
/
{instanceId}
/
token
/
{token}
/
contacts
/
{phone}
Contact metadata
curl --request GET \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/contacts/{phone} \
  --header 'Client-Token: <api-key>'
{
  "name": "<string>",
  "phone": "<string>",
  "notify": "<string>",
  "short": "<string>",
  "imgUrl": "<string>",
  "about": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://developer.z-api.io/llms.txt

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

​
Overview

This method is responsible for returning the contact’s metadata information.
If you intend to store your contact’s image, note that we always return the imgUrl attribute in get-contacts, however it’s important to remember that it’s only available for 48 hours per WhatsApp’s policy.

​
Attributes

​
instanceId
string
required
Your instance ID. Available in the Z-API panel under Instances.
​
token
string
required
Your Z-API instance token.

​
Path

​
phone
string
required
Contact phone number in DDI DDD NUMBER format. E.g.: 551199999999

​
Response

​
200

​
name
string
Contact’s full name
​
phone
string
Contact number
​
notify
string
Contact’s WhatsApp name
​
short
string
Contact’s short name
​
imgUrl
string
Contact’s profile photo URL (expires in 48 hours)
​
about
string
Contact’s profile status
{
  "name": "Contact full name",
  "phone": "551199999999",
  "notify": "WhatsApp name",
  "short": "Contact name",
  "imgUrl": "https://...",
  "about": "Profile status"
}

​
405

Make sure you are correctly sending the method specification, that is, verify that you sent POST or GET as specified at the beginning of this topic.

​
415

If you receive a 415 error, make sure to add the “Content-Type” header to your request, which in most cases is “application/json”.