Get invite info
Returns the group information behind an invite code. Pass the code as the inviteCode query parameter (e.g. ?inviteCode=F1EX5QZxO181L3TMVP31gY).
curl --request GET \
--url https://pilotstatus.com.br/api/layer/evolution-v2/group/inviteInfo/{instance} \
--header 'apikey: <api-key>'import requests
url = "https://pilotstatus.com.br/api/layer/evolution-v2/group/inviteInfo/{instance}"
headers = {"apikey": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {apikey: '<api-key>'}};
fetch('https://pilotstatus.com.br/api/layer/evolution-v2/group/inviteInfo/{instance}', 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://pilotstatus.com.br/api/layer/evolution-v2/group/inviteInfo/{instance}",
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://pilotstatus.com.br/api/layer/evolution-v2/group/inviteInfo/{instance}"
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://pilotstatus.com.br/api/layer/evolution-v2/group/inviteInfo/{instance}")
.header("apikey", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/api/layer/evolution-v2/group/inviteInfo/{instance}")
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{
"id": "120363021234567890@g.us",
"subject": "Equipe Pilot Status",
"subjectOwner": "5511999999999@s.whatsapp.net",
"subjectTime": 1720545600,
"size": 3,
"creation": 1720545600,
"owner": "5511999999999@s.whatsapp.net",
"desc": "Grupo oficial da equipe.",
"descId": "BAE5A1B2C3D4E5F6",
"restrict": false,
"announce": false,
"participants": [
{
"id": "5511999999999@s.whatsapp.net",
"admin": "superadmin"
},
{
"id": "5511988888888@s.whatsapp.net",
"admin": null
}
]
}{
"status": 400,
"error": "Bad Request",
"message": "Invalid payload"
}Authorizations
Your Pilot Status API key (ps_...). Evolution GO also accepts Authorization: Bearer <key>.
Path Parameters
The number's display name in the Pilot Status dashboard.
Response
Success — provider-native response body.
Raw Baileys group metadata resolved from an invite code (client.groupGetInviteInfo).
Group JID.
Group name/subject.
JID of the participant who last set the subject.
Unix timestamp (seconds) when the subject was last set.
Number of participants.
Unix timestamp (seconds) when the group was created.
JID of the group owner/creator.
Group description text.
Identifier of the current description.
If true, only admins can edit group info.
If true, only admins can send messages (announcement group).
Group participants.
Show child attributes
Show child attributes
Was this page helpful?
curl --request GET \
--url https://pilotstatus.com.br/api/layer/evolution-v2/group/inviteInfo/{instance} \
--header 'apikey: <api-key>'import requests
url = "https://pilotstatus.com.br/api/layer/evolution-v2/group/inviteInfo/{instance}"
headers = {"apikey": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {apikey: '<api-key>'}};
fetch('https://pilotstatus.com.br/api/layer/evolution-v2/group/inviteInfo/{instance}', 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://pilotstatus.com.br/api/layer/evolution-v2/group/inviteInfo/{instance}",
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://pilotstatus.com.br/api/layer/evolution-v2/group/inviteInfo/{instance}"
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://pilotstatus.com.br/api/layer/evolution-v2/group/inviteInfo/{instance}")
.header("apikey", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://pilotstatus.com.br/api/layer/evolution-v2/group/inviteInfo/{instance}")
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{
"id": "120363021234567890@g.us",
"subject": "Equipe Pilot Status",
"subjectOwner": "5511999999999@s.whatsapp.net",
"subjectTime": 1720545600,
"size": 3,
"creation": 1720545600,
"owner": "5511999999999@s.whatsapp.net",
"desc": "Grupo oficial da equipe.",
"descId": "BAE5A1B2C3D4E5F6",
"restrict": false,
"announce": false,
"participants": [
{
"id": "5511999999999@s.whatsapp.net",
"admin": "superadmin"
},
{
"id": "5511988888888@s.whatsapp.net",
"admin": null
}
]
}{
"status": 400,
"error": "Bad Request",
"message": "Invalid payload"
}