Retrieve All Members from All Groups

GET 
/api/v2/instance/:instanceId/group/all-lists-participants

This endpoint allows you to retrieve the list of all participants of all WhatsApp groups. It returns a complete list of all participants present in all groups.

Request

Path Parameters

instanceId stringrequired

ID of the instance.

Responses

200

FindParticipantsAllGroupResponse

application/json

Schema

Schema

• Array [
groupJid stringrequired
participants object[]required
Array [
id stringrequired
name string
notify string
verifiedName string
imgUrl string
status string
isAdmin boolean
isSuperAdmin boolean
admin string
Default value: admin | superadmin
]
• ]

Example (from schema)

[
  {
    "groupJid": "string",
    "participants": [
      {
        "id": "string",
        "name": "string",
        "notify": "string",
        "verifiedName": "string",
        "imgUrl": "string",
        "status": "string",
        "isAdmin": true,
        "isSuperAdmin": true,
        "admin": "admin | superadmin"
      }
    ]
  }
]

400

BadRequestException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

401

UnauthorizedException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

500

InternalServerErrorException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

Loading...