Skip to main content
GET
Get chats with a specific label

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

instanceId
string<uuid>
required

The WhatsApp instance UUID

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

labelId
string
required

Label ID

Response

Chats with the label

id
string
required

Chat ID (phone@c.us for DMs, JID@g.us for groups)

Example:

"5511999999999@c.us"

timestamp
number
required

Last activity timestamp (epoch seconds)

Example:

1707350400

unreadCount
number
required

Number of unread messages

Example:

3

name
string

Contact or group name

Example:

"John Doe"