Skip to main content
GET
/
api
/
instances
/
{instanceId}
/
groups
List groups
curl --request GET \
  --url https://api.wappfy.io/api/instances/{instanceId}/groups \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "[email protected]",
    "subject": "Team Chat",
    "participants": [
      {
        "id": "[email protected]",
        "admin": "admin"
      }
    ],
    "creation": 1707350400,
    "description": "<string>",
    "pictureUrl": "<string>"
  }
]

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
default:50

Maximum number of items to return

​
offset
number
default:0

Number of items to skip

Response

List of groups

​
id
string
required

Group JID

Example:

"[email protected]"

​
subject
string
required

Group subject/title

Example:

"Team Chat"

​
participants
object[]
required

Group members

​
creation
number
required

Creation timestamp

Example:

1707350400

​
description
string

Group description text

​
pictureUrl
string

Group picture URL