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
groups
collection. - Filters out all records not having a
uid
in themembers
field corresponding to the one passed if they have a value ofprivate
for theirprivacy
field. - Removes the
has_muted
field for each record in theirmembers
field. - Sets empty values for
members
ifuid
does not correspond to a record in themembers
field with astatus
ofaccepted
. - Finds the
group
that has a value for itsgroupID
field that corresponds to the one passed [404].