1. WhatsApp
Nabd Messaging
  • WhatsApp
    • Send a text message (WhatsApp)
      POST
    • Send an image or document (WhatsApp)
      POST
    • Send a saved template (WhatsApp)
      POST
    • Check whether a phone number is on WhatsApp
      POST
    • Resolve a WhatsApp identity (phone, WhatsApp ID, or username)
      POST
    • List WhatsApp chats
      POST
    • List WhatsApp groups
      POST
    • Read the WhatsApp device status
      POST
  • Telegram
    • Send a text message (Telegram)
      POST
    • Send an image or document (Telegram)
      POST
    • Send a saved template (Telegram)
      POST
    • List Telegram chats and dialogs
      POST
    • List Telegram groups and channels
      POST
    • Read the Telegram account status
      POST
  • Templates
    • List templates
      POST
    • Get a template
      POST
  • Messages
    • List sent messages
      POST
    • Get a sent message
      POST
  • Phonebook
    • List contacts
      POST
    • Create a contact
      POST
    • Update a contact
      POST
    • Delete a contact
      POST
    • List contact groups
      POST
    • Create a contact group
      POST
    • Delete a contact group
      POST
    • Add contacts to a group
      POST
    • Remove contacts from a group
      POST
  • Scheduling
    • Schedule a message
    • List scheduled messages
    • Cancel a scheduled message
  • Account
    • Read account usage and limits
  • Schemas
    • AuthKeys
    • AuthKeyOnlyRequest
    • AuthAppRequest
    • WhatsAppSendTextRequest
    • ContactsResponse
    • WhatsAppSendMediaRequest
    • SendTemplateRequest
    • GroupsResponse
    • TelegramSendTextRequest
    • TelegramSendMediaRequest
    • ResolveResponse
    • NumberCheckRequest
    • LookupRequest
    • ValidationError
    • ChatsRequest
    • UsernameError
    • TemplatesListRequest
    • WaServerError
    • TemplatesGetRequest
    • WaDeviceNotConnected
    • MessagesListRequest
    • MessagesGetRequest
    • ResolveRateLimit
    • ContactsListRequest
    • ContactsCreateRequest
    • RateLimitAny
    • ContactsUpdateRequest
    • ReqIdRequest
    • ReqGroupIdRequest
    • ReqScheduleIdRequest
    • ContactGroupsCreateRequest
    • AddRemoveContactsRequest
    • ScheduleCreateRequest
    • ScheduleListRequest
    • Envelope
    • PaginatedEnvelope
    • Error
    • RateLimitExceededSchema
    • LookupResponse
    • ChatsResponse
    • GroupsChatsResponse
    • TelegramDialogsResponse
    • ContactItem
    • AuthRequest
    • ContactsRequest
    • CreateMessageRequest
    • CreateMessageResponse
    • ResolveRequest
    • AuthError
    • RateLimitExceeded
    • SendBlocked
  1. WhatsApp

List WhatsApp chats

POST
/api/whatsapp/chats
Last modified:2026-09-29 09:27:11
List the open chats of the app's WhatsApp device.
Use it to show a "recent conversations" list, or to discover who your
customers are. The channel is always WhatsApp — a channel field in the
body is ignored.
By default, chats with no phone number (customers who hide their
number) are excluded. Pass include_lid: 1 to include them; their
number and phone are null and you reach them with their WhatsApp ID
(jid).
Each data[] item: number, jid, phone, lid, username, name,
unread, timestamp. The response has a meta object with count and
device (name, phone).
This is the resource replacement for the legacy get-contacts.

Request

Body Params application/jsonRequired

Examples

Responses

🟢200
application/json
Chats returned.
Bodyapplication/json

🔴500
🟠401Error401
🟠429Error429
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location '/api/whatsapp/chats' \
--header 'Content-Type: application/json' \
--data '{
    "authkey": "{{authkey}}",
    "appkey": "{{appkey}}"
}'
Response Response Example
200 - success
{
    "success": true,
    "data": [
        {
            "number": "966501234567",
            "jid": "966501234567@s.whatsapp.net",
            "phone": "966501234567",
            "lid": null,
            "username": null,
            "name": "Ahmed",
            "unread": 2,
            "timestamp": 1700000000
        },
        {
            "number": null,
            "jid": "123456789012345@lid",
            "phone": null,
            "lid": "123456789012345",
            "username": "ahmed.shop",
            "name": null,
            "unread": 0,
            "timestamp": 0
        }
    ],
    "meta": {
        "count": 2,
        "device": {
            "name": "My device",
            "phone": "966500000000"
        }
    }
}
Modified at 2026-09-29 09:27:11
Previous
Resolve a WhatsApp identity (phone, WhatsApp ID, or username)
Next
List WhatsApp groups
Built with