Skip to main content
GET
Get contacts

Overview

This method is responsible for returning all WhatsApp contacts.

Attributes

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

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