Get contacts
Contacts
Get contacts
Returns all WhatsApp contacts
GET
Get contacts
Overview
This method is responsible for returning all WhatsApp contacts.Attributes
Header
string
required
Your instance ID. Available in the Z-API panel under Instances.
string
required
Your Z-API instance token.
Query Parameters
integer
required
Used for pagination, you must specify the contact page you want to fetch
integer
required
Specifies the number of contacts returned per page
Response
200
string
Contact phone number
string
Contact’s full name, only returns filled if you have the number in your contacts
string
Contact’s short name, only returns filled if you have the number in your contacts
string
Contact name if you have them as a contact
string
Name set in WhatsApp name settings