Skip to main content
GET
/
groups
List joined groups
curl --request GET \
  --url https://api.wsapi.chat/groups \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Instance-Id: <x-instance-id>'
[
  {
    "groupId": "<string>",
    "owner": {
      "id": "1234567890@s.whatsapp.net",
      "lid": "222424242@lid",
      "phone": "1234567890",
      "device": 2
    },
    "name": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "isAnnounce": true,
    "isLocked": true,
    "isEphemeral": true,
    "ephemeralExpiration": 123,
    "participants": [
      {
        "id": "1234567890@s.whatsapp.net",
        "lid": "222424242@lid",
        "phone": "1234567890",
        "device": 2,
        "isAdmin": true,
        "isSuperAdmin": true,
        "displayName": "<string>"
      }
    ],
    "communityId": "<string>",
    "isAnnouncementGroup": true,
    "isJoinApprovalRequired": true,
    "memberAddMode": "<string>"
  }
]

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 groups

​
groupId
string
​
owner
object

Represents a WhatsApp user with all known identifiers. The id field is always present: it prefers a phone-based JID, falling back to LID.

​
name
string
​
createdAt
string<date-time>
​
description
string
​
isAnnounce
boolean
​
isLocked
boolean
​
isEphemeral
boolean
​
ephemeralExpiration
integer<int64>
​
participants
object[]
​
communityId
string
​
isAnnouncementGroup
boolean
​
isJoinApprovalRequired
boolean
​
memberAddMode
string