Skip to main content
GET
/
instances
/
{instanceId}
/
token
/
{token}
/
contacts
Get contacts
curl --request GET \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/contacts \
  --header 'Client-Token: <api-key>'
{
  "phone": "<string>",
  "name": "<string>",
  "short": "<string>",
  "vname": "<string>",
  "notify": "<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 all WhatsApp contacts.

​
Attributes

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

​
Query Parameters

​
page
integer
required
Used for pagination, you must specify the contact page you want to fetch
​
pageSize
integer
required
Specifies the number of contacts returned per page

​
Response

​
200

​
phone
string
Contact phone number
​
name
string
Contact’s full name, only returns filled if you have the number in your contacts
​
short
string
Contact’s short name, only returns filled if you have the number in your contacts
​
vname
string
Contact name if you have them as a contact
​
notify
string
Name set in WhatsApp name settings
[
  {
    "name": "Contact full name",
    "short": "Contact name",
    "notify": "WhatsApp name",
    "vname": "Vcard name",
    "phone": "559999999999"
  }
]

​
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”.