Link Search Menu Expand Document

Fetch All

/api/v2/group/fetch

Post

groups

jwt

pgn


Purpose

To allow a user to fetch groups that he/she is a member of or to have some details about those that are public.

Body Content [input]

{
    uid: string
}

Returns if valid [output]

{
    groups: {
        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 the members field corresponding to the one passed if they have a value of private for their privacy field.
  • Removes the has_muted field for each record in their members field.
  • Sets empty values for members if uid does not correspond to a record in the members field with a status of accepted.