Sign in

v1

latestOpenAPI 3.0.02026-07-14181255304.7 KB
Groups

Get group

This method returns the group metadata with all information about the group and its participants

get/groups/{GroupID}

Path parameters

GroupIDstring required

Group ID

Group ID

Query parameters

resyncboolean

If set to true, the channel will resync its data.

Response

OK

idstring required

Chat ID

phonestring

Phone number

namestring required

Group name

type'group' | 'contact' | 'broadcast' | 'newsletter' | 'stories' | 'announcement' | 'unknown' required

Chat type

timestampinteger

Chat timestamp

chat_picstring

Chat picture URL

chat_pic_fullstring

Chat full picture URL

pinboolean

Is chat pinned

muteboolean

Is chat muted

mute_untilinteger

Chat mute until

archiveboolean

Is chat archived

unreadinteger

Unread messages count

unread_mentionboolean

Is chat unread mention

read_onlyboolean

Is chat read only

not_spamboolean

Is chat not spam

name_ownerstring

Group name owner

name_atinteger

Group name change timestamp

descriptionstring

Group description

description_ownerstring

Group description owner

description_idstring

Group description ID

participants_countinteger required

Number of participants in the group

created_atinteger

Group creation timestamp

created_bystring

Contact ID

suspendedboolean

Is group suspended

terminatedboolean

Is group terminated

is_parentboolean

Is group parent

is_default_subgroupboolean

Is group default subgroup

restrictedboolean

If only admins can change group settings

announcementsboolean

If only admins can send messages

adminAddMemberModeboolean

If only admins can add members

ephemeralnumber

Group ephemeral timer

performed_bystring

Chat ID

invite_codestring

Group invite code

isCommunityAnnounceboolean

If group is community announce

linkedParentstring

Chat ID