Fetch One
/api/v2/group/fetch/one
Post
groups
jwt
Purpose
To allow a user to fetch one group that he/she is a member of or to have some details about it if it is public.
Body Content [input]
{
uid: string,
groupID: string
}
Returns if valid [output]
{
groupID: string,
name: string,
description: string,
privacy: string,
icon: string,
cover_image: string,
members: {
uid: string,
is_admin: bool,
status: string
}[],
error: 0,
amount: int
}
What the API does
- Finds all records from the
groupscollection. - Filters out all records not having a
uidin themembersfield corresponding to the one passed if they have a value ofprivatefor theirprivacyfield. - Removes the
has_mutedfield for each record in theirmembersfield. - Sets empty values for
membersifuiddoes not correspond to a record in themembersfield with astatusofaccepted. - Finds the
groupthat has a value for itsgroupIDfield that corresponds to the one passed [404].