Get list of participants in a group

curl --request GET \
  --url http://localhost:3000/group/participants \
  --header 'Authorization: Basic <encoded-value>'

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('http://localhost:3000/group/participants', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "3000",
  CURLOPT_URL => "http://localhost:3000/group/participants",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:3000/group/participants"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("http://localhost:3000/group/participants")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

{
  "code": "SUCCESS",
  "message": "Success getting group participants",
  "results": {
    "group_id": "120363024512399999@g.us",
    "name": "My Awesome Group",
    "participants": [
      {
        "jid": "6289987391723@s.whatsapp.net",
        "phone_number": "6289987391723@s.whatsapp.net",
        "lid": "12345@lid",
        "display_name": "Anonymous Member",
        "is_admin": true,
        "is_super_admin": false
      }
    ]
  }
}

{
  "code": 400,
  "message": "field cannot be blank",
  "results": null
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "you are not loggin",
  "results": null
}

GET

group

participants

Get list of participants in a group

curl --request GET \
  --url http://localhost:3000/group/participants \
  --header 'Authorization: Basic <encoded-value>'

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('http://localhost:3000/group/participants', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "3000",
  CURLOPT_URL => "http://localhost:3000/group/participants",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:3000/group/participants"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("http://localhost:3000/group/participants")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

{
  "code": "SUCCESS",
  "message": "Success getting group participants",
  "results": {
    "group_id": "120363024512399999@g.us",
    "name": "My Awesome Group",
    "participants": [
      {
        "jid": "6289987391723@s.whatsapp.net",
        "phone_number": "6289987391723@s.whatsapp.net",
        "lid": "12345@lid",
        "display_name": "Anonymous Member",
        "is_admin": true,
        "is_super_admin": false
      }
    ]
  }
}

{
  "code": 400,
  "message": "field cannot be blank",
  "results": null
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "you are not loggin",
  "results": null
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

X-Device-Id

string

Device identifier for multi-device support. Required when multiple devices are registered. If only one device is registered, it will be used as the default. Can also be provided as device_id query parameter.

Example:

"my-device-id"

Query Parameters

group_id

string

required

The group ID to fetch participants for

Response

code

string

Example:

"SUCCESS"

message

string

Example:

"Success getting group participants"

results

object

Show child attributes

WhatsApp API

Overview

Client Examples

Get list of participants in a group

Authorizations

Headers

Query Parameters

Response