Skip to main content
GET
/
api
/
instances
/
{instanceId}
/
chats
List chats
curl --request GET \
  --url https://api.wappfy.io/api/instances/{instanceId}/chats \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "[email protected]",
    "timestamp": 1707350400,
    "unreadCount": 3,
    "name": "John Doe"
  }
]

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"

Query Parameters

​
limit
number

Max results (default 50)

​
offset
number

Offset for pagination

Response

List of chats

​
id
string
required

Chat ID ([email protected] for DMs, [email protected] for groups)

Example:

"[email protected]"

​
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"