Group metadata
curl --request GET \
--url https://api.z-api.io/instances/{instanceId}/token/{token}/group-metadata/{phone} \
--header 'Client-Token: <api-key>'import requests
url = "https://api.z-api.io/instances/{instanceId}/token/{token}/group-metadata/{phone}"
headers = {"Client-Token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'Client-Token': '<api-key>'}};
fetch('https://api.z-api.io/instances/{instanceId}/token/{token}/group-metadata/{phone}', 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://api.z-api.io/instances/{instanceId}/token/{token}/group-metadata/{phone}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Client-Token: <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://api.z-api.io/instances/{instanceId}/token/{token}/group-metadata/{phone}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Client-Token", "<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://api.z-api.io/instances/{instanceId}/token/{token}/group-metadata/{phone}")
.header("Client-Token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.z-api.io/instances/{instanceId}/token/{token}/group-metadata/{phone}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Client-Token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"phone": "<string>",
"description": "<string>",
"owner": "<string>",
"subject": "<string>",
"creation": 123,
"invitationLink": "<string>",
"communityId": "<string>",
"adminOnlyMessage": true,
"adminOnlySettings": true,
"requireAdminApproval": true,
"isGroupAnnouncement": true,
"participants": [
{}
]
}Groups
Group metadata
Returns group metadata with all information and participants
GET
/
instances
/
{instanceId}
/
token
/
{token}
/
group-metadata
/
{phone}
Group metadata
curl --request GET \
--url https://api.z-api.io/instances/{instanceId}/token/{token}/group-metadata/{phone} \
--header 'Client-Token: <api-key>'import requests
url = "https://api.z-api.io/instances/{instanceId}/token/{token}/group-metadata/{phone}"
headers = {"Client-Token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'Client-Token': '<api-key>'}};
fetch('https://api.z-api.io/instances/{instanceId}/token/{token}/group-metadata/{phone}', 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://api.z-api.io/instances/{instanceId}/token/{token}/group-metadata/{phone}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Client-Token: <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://api.z-api.io/instances/{instanceId}/token/{token}/group-metadata/{phone}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Client-Token", "<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://api.z-api.io/instances/{instanceId}/token/{token}/group-metadata/{phone}")
.header("Client-Token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.z-api.io/instances/{instanceId}/token/{token}/group-metadata/{phone}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Client-Token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"phone": "<string>",
"description": "<string>",
"owner": "<string>",
"subject": "<string>",
"creation": 123,
"invitationLink": "<string>",
"communityId": "<string>",
"adminOnlyMessage": true,
"adminOnlySettings": true,
"requireAdminApproval": true,
"isGroupAnnouncement": true,
"participants": [
{}
]
}Overview
This method returns the group metadata with all group information and its participants.Attributes
Header
string
required
Your instance ID. Available in the Z-API panel under Instances.
string
required
Your Z-API instance token.
Path
string
required
Group ID/Phone
Response
200
string
Group ID/Phone
string
Group description
string
Group creator’s number
string
Group name
number
Group creation date (timestamp)
string
Group invitation link (admin only)
string
Community ID
boolean
Only admins can send messages
boolean
Only admins can change settings
boolean
Admin approval required to join
boolean
Whether it is an announcement group
array
Array with participant data
{
"phone": "120363019502650977-group",
"description": "Z-API Group",
"owner": "5511999999999",
"subject": "My group on Z-API",
"creation": 1588721491000,
"invitationLink": "https://chat.whatsapp.com/40Aasd6af1",
"communityId": null,
"adminOnlyMessage": false,
"adminOnlySettings": false,
"requireAdminApproval": false,
"isGroupAnnouncement": false,
"participants": [
{
"phone": "5511888888888",
"isAdmin": false,
"isSuperAdmin": false
},
{
"phone": "5511777777777",
"isAdmin": true,
"isSuperAdmin": false,
"short": "ZAPIs",
"name": "ZAPIs Boys"
}
],
"subjectTime": 1617805323000,
"subjectOwner": "554497050785"
}