Skip to main content
GET
Get a group

Authorizations

Authorization
string
header
required

Authorization: Bearer hmok_... API key or a dashboard session token

Path Parameters

ch
string
required

ch_ channel id

groupId
string
required

WhatsApp group id, as returned by the list and by whatsapp.group.updated events.

Pattern: ^(?!\d+$)[A-Za-z0-9+=_-]{1,256}$

Response

The group

channelId
string
required
groupId
string
required
subject
string | null
required
description
string | null
required
joinApprovalMode
string | null
required

auto_approve or approval_required

suspended
boolean | null
required
createdAt
string<date-time> | null
required
participantCount
integer | null
required
participants
object[]
required