Skip to main content
GET
/
chats
List all known chats
curl --request GET \
  --url https://wsapi.chat/chats \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Instance-Id: <x-instance-id>'
[
  {
    "id": "1234567890@s.whatsapp.net",
    "lid": "222424242@lid",
    "isGroup": true,
    "isArchived": true,
    "isPinned": true,
    "isMuted": true,
    "muteEndTime": "2023-11-07T05:31:56Z",
    "pushName": "<string>",
    "businessName": "<string>",
    "fullName": "<string>",
    "lastActivity": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
X-Api-Key
string
header
required

Instance or customer-level API key. Either the instance's own API key or the customer's API key is accepted. Must be paired with the X-Instance-Id header to identify the target instance.

Headers

​
X-Instance-Id
string
default:{{instanceId}}
required

The ID of the WhatsApp instance to use

Response

List of chats

​
id
string

Chat JID

Example:

"1234567890@s.whatsapp.net"

​
lid
string

LID-based JID for the chat (omitted for groups or if unknown)

Example:

"222424242@lid"

​
isGroup
boolean
​
isArchived
boolean
​
isPinned
boolean
​
isMuted
boolean
​
muteEndTime
string<date-time>

When the mute expires (omitted if not muted)

​
pushName
string

Contact push name (omitted if unknown)

​
businessName
string

Business name (omitted if not a business)

​
fullName
string

Full name from contacts (omitted if unknown)

​
lastActivity
string<date-time>

Timestamp of last activity (omitted if unknown)