Skip to main content
GET
/
instances
/
{instanceId}
/
token
/
{token}
/
group-invitation-metadata
Group metadata by invite
curl --request GET \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/group-invitation-metadata \
  --header 'Client-Token: <api-key>'

​
Overview

This method returns the group metadata with all group information and its participants through the invitation link.

​
Attributes

​
instanceId
string
required
Your instance ID. Available in the Z-API panel under Instances.
​
token
string
required
Your Z-API instance token.

​
Query Parameters

​
url
string
required
Group invitation link. E.g.: https://chat.whatsapp.com/KNmcL17DqVA0sqkQ5LLA5

​
Response

​
200

{
  "phone": "120363019502650977-group",
  "owner": "5511888888888",
  "subject": "My group on Z-API",
  "description": "group description",
  "creation": 1588721491000,
  "invitationLink": "https://chat.whatsapp.com/KNmcL17DqVA0sqkQ5LLA5",
  "contactsCount": 1,
  "participantsCount": 1,
  "participants": [
    {
      "phone": "5511888888888",
      "isAdmin": false,
      "isSuperAdmin": true
    },
    {
      "phone": "5511777777777",
      "isAdmin": false,
      "isSuperAdmin": false
    }
  ],
  "subjectTime": 1617805323000,
  "subjectOwner": "5511888888888"
}

​
405

Make sure you are correctly sending the method specification, that is, verify that you sent POST or GET as specified at the beginning of this topic.

​
415

If you receive a 415 error, make sure to add the “Content-Type” header to your request, which in most cases is “application/json”.