Skip to main content
POST
Get group details and members

Authorizations

token
string
header
required

Body

application/json
groupjid
string
required

Unique group identifier (JID)

Example:

"120363153742561022@g.us"

Optional/advanced: requests the invite, available only to an administrator with confirmed permission.

Example:

true

getRequestsParticipants
boolean
default:false

Optional/advanced: requests join requests, available only to an administrator with confirmed permission.

Example:

false

force
boolean
default:false

Advanced: requests a remote update. Normal usage only requires groupjid.

Example:

false

Response

Group information successfully retrieved

Represents a group/collective conversation

JID
string<jid>

Unique group identifier

Example:

"jid8@g.us"

OwnerJID
string<jid>

Group owner JID

Example:

"1232@s.whatsapp.net"

OwnerPN
string<jid>

Owner number/LID (when available)

Name
string

Group name

Example:

"Support Group"

NameSetAt
string<date-time>

Date of the last name change

NameSetBy
string<jid>

JID of the user who set the name

NameSetByPN
string<jid>

LID/PN of who set the name

Topic
string

Group description

TopicID
string

Internal description ID

TopicSetAt
string<date-time>

Date of the last description change

TopicSetBy
string<jid>

JID of who changed the description

TopicSetByPN
string<jid>

LID/PN of who changed the description

TopicDeleted
boolean

Indicates whether the description was deleted

IsLocked
boolean

Indicates whether only administrators can edit group info

  • true = only admins can edit
  • false = everyone can edit
Example:

true

IsAnnounce
boolean

Indicates whether only administrators can send messages

AnnounceVersionID
string

Announcement settings version

IsEphemeral
boolean

Indicates whether messages are disappearing

DisappearingTimer
integer

Time in seconds for messages to disappear

Required range: x >= 0
IsIncognito
boolean

Indicates whether the group is incognito

IsParent
boolean

Indicates whether it is a parent group (community)

IsJoinApprovalRequired
boolean

Indicates whether approval is required for new members

LinkedParentJID
string<jid>

JID of the linked community

IsDefaultSubGroup
boolean

Indicates whether it is a default subgroup of the community

DefaultMembershipApprovalMode
string

Default member approval mode (when community)

GroupCreated
string<date-time>

Group creation date

CreatorCountryCode
string

Creator's country code

ParticipantVersionID
string

Participant list version

Participants
object[] | null

List of participants. It is null when omitted by noParticipants and may be empty when participant_profiles is present.

MemberAddMode
enum<string>

Mode for adding new members

Available options:
,
admin_add,
all_member_add
AddressingMode
enum<string>

Group's preferred addressing

Available options:
,
pn,
lid
OwnerCanSendMessage
boolean

Checks whether you are able to send messages

OwnerIsAdmin
boolean

Indicates confirmed administrator privilege. May be absent when false; partial data does not grant administrator privilege.

DefaultSubGroupId
string

If the current group is a community, this field shows the ID of the announcements subgroup

Invite link, exposed only to admins with confirmed permission. May be absent; do not assume every read queries WhatsApp.

request_participants
string

Known join requests, comma-separated. Exposed only to administrators when requested.

image_url
string

URL of the already persisted full image; the API does not query WhatsApp during listing

image_preview_url
string

URL of the already persisted preview

picture_id
string

Identifier of the full image on WhatsApp

picture_preview_id
string

Preview identifier on WhatsApp

picture_empty_at
string<date-time>

Last confirmation that the group had no image

image_checked_at
string<date-time>

Last full image query

image_preview_checked_at
string<date-time>

Last preview query

parent_community
object

Summary of a subgroup's parent community

participant_profiles
object[]

Additional participant profiles, when available. Missing fields must not be inferred.

ParticipantCount
integer

Known number of participants. May differ from the list size when data is partial or has been omitted from the response.

Required range: x >= 0
request_participants_lid
string

LIDs of known join requests, comma-separated; admin only, when requested.