Skip to main content
GET
/
instances
/
{instanceId}
/
token
/
{instanceToken}
/
contacts
Listar contatos
curl --request GET \
  --url https://api.ezapi.com.br/instances/{instanceId}/token/{instanceToken}/contacts \
  --header 'Client-Token: <api-key>'
[
  {
    "phone": "5511999999999",
    "name": "Maria Silva",
    "short": "Maria",
    "vname": "Maria Silva",
    "notify": "Maria Silva"
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.ezapi.com.br/llms.txt

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

Lista os contatos conhecidos pela instância com paginação.
Aliases consolidados da collection: Pegar contatos.

Authorizations

​
Client-Token
string
header
required

Path Parameters

​
instanceId
string
required

Identificador único da instância.

Example:

"abc1234567890"

​
instanceToken
string
required

Token privado da instância retornado na criação.

Example:

"tok_a1b2c3d4e5f6"

Query Parameters

​
page
integer

Utilizado para paginação você de informar aqui a pagina de contatos que quer buscar

Example:

1

​
pageSize
integer

Especifica o tamanho do retorno de contatos por pagina

Example:

20

Response

Resposta de sucesso.

​
phone
string
required
Example:

"5511999999999"

​
name
string
required
Example:

"Maria Silva"

​
short
string
required
Example:

"Maria"

​
vname
string
required
Example:

"Maria Silva"

​
notify
string
required
Example:

"Maria Silva"

Example:
[
  {
    "phone": "5511999999999",
    "name": "Maria Silva",
    "short": "Maria",
    "vname": "Maria Silva",
    "notify": "Maria Silva"
  }
]