Skip to main content
GET
Get group info from invite code

Authorizations

X-Api-Key
string
header
required

Instance or customer-level API key. Either the instance's own API key or the customer's API key is accepted. Must be paired with the X-Instance-Id header to identify the target instance.

Headers

X-Instance-Id
string
default:{{instanceId}}
required

The ID of the WhatsApp instance to use

Path Parameters

code
string
required

Invite link code

Response

Group info from invite link

groupId
string
owner
object

Represents a WhatsApp user with all known identifiers. The id field is always present: it prefers a phone-based JID, falling back to LID.

name
string
createdAt
string<date-time>
description
string
isAnnounce
boolean
isLocked
boolean
isEphemeral
boolean
ephemeralExpiration
integer<int64>
participants
object[]
communityId
string
isAnnouncementGroup
boolean
isJoinApprovalRequired
boolean
memberAddMode
string