List
curl --request GET \
--url https://{appid}.api-{region}.cometchat.io/v3/groups/{guid}/members \
--header 'apikey: <api-key>'import requests
url = "https://{appid}.api-{region}.cometchat.io/v3/groups/{guid}/members"
headers = {"apikey": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {apikey: '<api-key>'}};
fetch('https://{appid}.api-{region}.cometchat.io/v3/groups/{guid}/members', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{appid}.api-{region}.cometchat.io/v3/groups/{guid}/members",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"apikey: <api-key>"
],
]);
$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 := "https://{appid}.api-{region}.cometchat.io/v3/groups/{guid}/members"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("apikey", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{appid}.api-{region}.cometchat.io/v3/groups/{guid}/members")
.header("apikey", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{appid}.api-{region}.cometchat.io/v3/groups/{guid}/members")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["apikey"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"uid": "superhero2",
"name": "Captain America",
"avatar": "https://data-us.cometchat.io/assets/images/avatars/captainamerica.png",
"status": "offline",
"role": "default",
"scope": "participant",
"joinedAt": 1638360106,
"createdAt": 1629869270,
"updatedAt": 1630308676,
"conversationId": "superhero2_user_superhero4"
},
{
"uid": "superhero3",
"name": "Captain America",
"link": "https://data-us.cometchat.io/assets",
"avatar": "https://data-us.cometchat.io/assets/images/avatars/captainamerica.png",
"metadata": {
"contactNumber": "0123456789"
},
"status": "offline",
"role": "default",
"scope": "participant",
"joinedAt": 1638360106,
"createdAt": 1629869270,
"updatedAt": 1638351060,
"conversationId": "superhero3_user_superhero4"
},
{
"uid": "superhero5",
"name": "Cyclops",
"avatar": "https://data-us.cometchat.io/assets/images/avatars/cyclops.png",
"status": "offline",
"role": "default",
"scope": "moderator",
"joinedAt": 1638360106,
"createdAt": 1629869270,
"conversationId": "superhero4_user_superhero5"
},
{
"uid": "superhero4",
"name": "Wolverine",
"avatar": "https://data-us.cometchat.io/assets/images/avatars/wolverine.png",
"status": "offline",
"role": "default",
"scope": "admin",
"joinedAt": 1638359534,
"createdAt": 1629869270
}
],
"meta": {
"pagination": {
"total": 0,
"count": 5,
"per_page": 100,
"current_page": 1,
"total_pages": 1
}
},
"cursor": {
"updatedAt": 1638354799,
"affix": "prepend"
}
}Group Members
List
List the members of a group for a given GUID
GET
/
groups
/
{guid}
/
members
List
curl --request GET \
--url https://{appid}.api-{region}.cometchat.io/v3/groups/{guid}/members \
--header 'apikey: <api-key>'import requests
url = "https://{appid}.api-{region}.cometchat.io/v3/groups/{guid}/members"
headers = {"apikey": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {apikey: '<api-key>'}};
fetch('https://{appid}.api-{region}.cometchat.io/v3/groups/{guid}/members', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{appid}.api-{region}.cometchat.io/v3/groups/{guid}/members",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"apikey: <api-key>"
],
]);
$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 := "https://{appid}.api-{region}.cometchat.io/v3/groups/{guid}/members"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("apikey", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{appid}.api-{region}.cometchat.io/v3/groups/{guid}/members")
.header("apikey", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{appid}.api-{region}.cometchat.io/v3/groups/{guid}/members")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["apikey"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"uid": "superhero2",
"name": "Captain America",
"avatar": "https://data-us.cometchat.io/assets/images/avatars/captainamerica.png",
"status": "offline",
"role": "default",
"scope": "participant",
"joinedAt": 1638360106,
"createdAt": 1629869270,
"updatedAt": 1630308676,
"conversationId": "superhero2_user_superhero4"
},
{
"uid": "superhero3",
"name": "Captain America",
"link": "https://data-us.cometchat.io/assets",
"avatar": "https://data-us.cometchat.io/assets/images/avatars/captainamerica.png",
"metadata": {
"contactNumber": "0123456789"
},
"status": "offline",
"role": "default",
"scope": "participant",
"joinedAt": 1638360106,
"createdAt": 1629869270,
"updatedAt": 1638351060,
"conversationId": "superhero3_user_superhero4"
},
{
"uid": "superhero5",
"name": "Cyclops",
"avatar": "https://data-us.cometchat.io/assets/images/avatars/cyclops.png",
"status": "offline",
"role": "default",
"scope": "moderator",
"joinedAt": 1638360106,
"createdAt": 1629869270,
"conversationId": "superhero4_user_superhero5"
},
{
"uid": "superhero4",
"name": "Wolverine",
"avatar": "https://data-us.cometchat.io/assets/images/avatars/wolverine.png",
"status": "offline",
"role": "default",
"scope": "admin",
"joinedAt": 1638359534,
"createdAt": 1629869270
}
],
"meta": {
"pagination": {
"total": 0,
"count": 5,
"per_page": 100,
"current_page": 1,
"total_pages": 1
}
},
"cursor": {
"updatedAt": 1638354799,
"affix": "prepend"
}
}Authorizations
API Key with fullAccess scope(i.e. Rest API Key from the Dashboard).
Path Parameters
A GUID of a group.
Query Parameters
Number of users to be fetched in a request. The default value is 100 and the maximum value is 1000.
Group members list can be fetched depending on the user status. (available,offline).
Available options:
available, offline Page Number.
Fetches group members based on multiple scope.
Response
200 - application/json
Create Group Members
⌘I