Skip to main content
GET
/
instances
/
{instanceId}
/
token
/
{instanceToken}
/
chats
Listar conversas
curl --request GET \
  --url https://api.ezapi.com.br/instances/{instanceId}/token/{instanceToken}/chats \
  --header 'Client-Token: <api-key>'
[
  {
    "isGroup": false,
    "name": "Maria Silva",
    "phone": "5511999999999",
    "unread": "0",
    "lastMessageTime": 1736200000,
    "isMuted": "0",
    "isMarkedSpam": false,
    "archived": false,
    "pinned": false,
    "muteEndTime": null,
    "messagesUnread": 0
  }
]
Lista conversas e grupos conhecidos pela instância.
Aliases consolidados da collection: Pegar chats.

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 chats que quer buscar

Example:

1

​
pageSize
integer

Especifica o tamanho do retorno de chats por pagina

Example:

20

Response

Resposta de sucesso.

​
isGroup
boolean
required
Example:

false

​
name
string
required
Example:

"Maria Silva"

​
phone
string
required
Example:

"5511999999999"

​
unread
string
required
Example:

"0"

​
lastMessageTime
integer
required
Example:

1736200000

​
isMuted
string
required
Example:

"0"

​
isMarkedSpam
boolean
required
Example:

false

​
archived
boolean
required
Example:

false

​
pinned
boolean
required
Example:

false

​
muteEndTime
unknown
required
​
messagesUnread
integer
required
Example:

0

Example:
[
  {
    "isGroup": false,
    "name": "Maria Silva",
    "phone": "5511999999999",
    "unread": "0",
    "lastMessageTime": 1736200000,
    "isMuted": "0",
    "isMarkedSpam": false,
    "archived": false,
    "pinned": false,
    "muteEndTime": null,
    "messagesUnread": 0
  }
]