Skip to main content
GET
Get community info

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

id
string
required

Community JID

Response

Community info

communityId
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
created
string<date-time>
description
string
isLocked
boolean
communityApprovalMode
string
participants
object[]