Get contacts

Method#

/contacts#

GET https://api.z-api.io/instances/YOUR_INSTANCE/token/YOUR_TOKEN/contacts

Header#

Key	Value
Client-Token	ACCOUNT SECURITY TOKEN

Concept#

This method is responsible for returning all of your WhatsApp contacts. Remember what was said in the introduction about contact numbers. In case you skipped this part, I suggest that you take a step back and read our introduction.

Attributes#

Required#

Attributes	Type	Description
page	integer	Used for pagination you have to inform here the contact page you want to search
pageSize	integer	Specifies the size of the contact return per page

Optionals#

Attributes	Type	Description

Request Params#

URL example#

Method

GET https://api.z-api.io/instances/YOUR_INSTANCE/token/YOUR_TOKEN/contacts?page=1&pageSize=20

Response#

200#

Attributes	Type	Description
phone	string	Contacts phone
name	string	First and last name of the contact, it will only return filled in if you have the number in your contacts
short	string	Contact name, it will only return filled in if you have the number in your contacts
vname	string	Contact name if you have him as a contact
notify	string	Name entered in WhatsApp name settings

Example

[
  {
    "name": "Nome e sobrenome do contato 1",
    "short": "Nome do contato 1",
    "notify": "Nome no WhatsApp 1",
    "vname": "Nome no vcard",
    "phone": "559999999999"
  }
]

405#

In this case certify that you are sending the correct specification of the method. This means, verify if you sent a POST or GET as specified at the beginning of this topic.

415#

In case you receive 415 error, make sure to add the “Content-Type” of the object you are sending in the request headers, mostly “application/json”