Link Search Menu Expand Document

Fetch

/api/v2/post/fetch

Post

posts

jwt

pgn


Purpose

To allow a user to fetch all the posts he/she has created.

Body Content [input]

{
    uid: string
}

Returns if valid [output]

{
    posts: {
        uid: string,
        postID: string,
        content: string,
        posted_on: Date,
        modified_on: Date,
        reacts: string[],
        groupID: string,
        shareID: string,
        comments: {
            uid: string,
            commentID: string,
            reply_to: string,
            posted_on: Date,
            modified_on: Date,
            reacts: string[],
            visibility: string
        }[],
        visibility: string,
        allow_comments: bool,
        senderName: string,
        senderUsername: string,
        groupName: string
    }[],
    error: 0,
    amount: int
}

What the API does

  • Find all records from the posts collection having the same value for their uid field as that of the uid passed.
  • Adds the name of the group to each of the posts if they have a value for their groupID field to the groupName field.
  • Appends the name and username of the poster to each post record to the senderName and senderUsername fields respectively.

Note: The owner of a post can see all the comments under that post irrespective of the visibility set on each comment.