Retrieve Group Members

GET 
/api/v2/instance/:instanceId/group/:groupJid/participant-list

This endpoint allows you to retrieve the list of participants of a specific WhatsApp group. The group_id parameter is used to identify the group for which you want to get the list of participants.

Request

Path Parameters

instanceId stringrequired

The unique identifier of the group for which you want to retrieve the participant list.

groupJid stringrequired

Group ID

Responses

200

Response Success

application/json

Schema

Schema

• Array [
[key: string] string
• ]

Example (from schema)

[
  {
    "[key: string]": "string"
  }
]

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...