Skip to main content
GET
/
api
/
{session}
/
groups
/
join-info
Get information about the group before joining
curl --request GET \
  --url https://{host}/api/{session}/groups/join-info \
  --header 'apikey: <api-key>'
{
  "id": "120363XXXXX@g.us",
  "subject": "Example Group",
  "description": "Description of the group",
  "participantCount": 50
}

Documentation Index

Fetch the complete documentation index at: https://docs.wappfy.com.br/llms.txt

Use this file to discover all available pages before exploring further.

​
Description

This endpoint allows viewing group information before joining it, using the invite code.

​
URL Parameters

​
session
string
required
WhatsApp unique session ID

​
Query Params

​
code
string
required
Invite code of the group

​
Response

​
id
string
ID of the group
​
subject
string
Name of the group
​
description
string
Description of the group
{
  "id": "120363XXXXX@g.us",
  "subject": "Example Group",
  "description": "Description of the group",
  "participantCount": 50
}

​
Status Codes

  • 200 - Information returned successfully
  • 400 - Invalid code
  • 401 - Unauthorized
  • 404 - Group not found

​
Usage Example

curl -X GET "https://api.wappfy.com.br/api/my-session/groups/join-info?code=Abc123Xyz456"

Authorizations

​
apikey
string
header
required

Your Wappfy API key (get it at dash.wappfy.com.br)

Query Parameters

​
code
string
required

Group code (123) or url (https://chat.whatsapp.com/123)

Response

200 - application/json

The response is of type object.