Profile Settings
Fetch All Groups
Profile Settings
Fetch All Groups
Fetch all groups
GET
https://{server-url}
/
group
/
fetchAllGroups
/
{instance}
Authorizations
apikey
string
headerrequiredYour authorization key header
Path Parameters
instance
string
requiredID of the instance to connect
Query Parameters
getParticipants
boolean
requiredWhether to get the group members or not
Response
200 - application/json
id
string
requiredThe ID of the group.
subject
string
requiredThe subject (name) of the group.
subjectOwner
string
requiredThe ID of the user who set the subject.
subjectTime
integer
requiredThe timestamp when the subject was set.
pictureUrl
string
URL of the group's profile picture.
size
integer
requiredThe number of participants in the group.
creation
integer
requiredThe timestamp when the group was created.
owner
string
requiredThe ID of the group owner.
desc
string
The description of the group.
descId
string
The ID of the description message.
restrict
boolean
requiredIndicates if the group is restricted (only admins can send messages).
announce
boolean
requiredIndicates if the group is an announcement group (only admins can send messages).