Skip to main content

Get logged in user profile and posts‚Äč

This API endpoint allows retrieving the profile details of a logged in user, user's posts, pages, followers count etc.

The tab parameter is used in the API to allow users to customize their results. By passing different values to tab in the API endpoint, users can fetch posts that meet specific criteria, such as the most popular or latest posts, or posts created by a specific user. Following table explain the tab value and expected results.

For some tab value, user need to be logged in otherwise system will return an empty array.

tab valueExplanationRequired user login
newestrecent posts at topNo
followingreturn reflections of authors that current user is followingYes
draftreturns current user's private notesYes
favoritereturns current user's favorite postsYes
most_populardefault tab value. Return most popular postsNo
Path Parameters
    username string required

    username of user

Query Parameters
    client_auth_token string required

    Client API token

    tab string

    Possible values: [draft, following, favorite, newest, most_popular]

Header Parameters
    access-token string required

    user access token

    client string required

    client token

    expiry string required

    timestamp of token expiry date

    token-type string required

    Default value: Bearer

    access token type

    uid string required

    user uid

Responses

User profile, notification and other settings and recent posts


Schema
    success boolean
    user_info object
    id integer
    username string
    name string
    first_name string
    last_name string
    verified boolean
    profile_img nullable
    followed boolean
    original_profile_img nullable
    rooms_list string[]
    display_name string
    user_type string
    user_notifications_settings object[]
  • Array [
  • id integer
    emails_disabled boolean
    follow_notification boolean
    followed_user_added_post_notification boolean
    post_commented_notification boolean
    post_liked_notification boolean
    mention_notification boolean
    added_post_in_group_notification boolean
    follow_push_notification boolean
    followed_user_added_post_push_notification boolean
    post_commented_push_notification boolean
    post_liked_push_notification boolean
    mention_push_notification boolean
    added_post_in_group_push_notification boolean
  • ]
  • posts_count integer
    followers integer
    followees integer
    posts object
    posts object[]
  • Array [
  • id integer

    The ID of the post.

    body string

    the post text

    likes integer

    The number of likes.

    draft boolean

    Whether the post should be publicly viewed or not.

    published_at string

    The date the post was published at. Format of the date is MMMM dd, yyyy HH:mm

    room_id nullable
    global boolean

    Whether the post is global or not. A post inside a room can be set to global and becomes visible to everyone.

    editable boolean

    Whether the post is editable or not. It will be true if the post belongs to the current user.

    deletable boolean

    Whether the post is deletable or not. It will be true if the post belongs to the current user.

    reportable boolean

    Whether the current user can report the post or not.

    citation_texts object[]
  • Array [
  • id integer
    text string

    translation text

    translated_name string

    name of the translation

    from integer

    from ayah number

    to integer

    to ayah number

    translation_id integer
  • ]
  • language string

    The language of the post.

    detected_translation integer
    views integer

    The number of views.

    group nullable
    group_link nullable
    comments object[]
    liked boolean
    author object
    id integer
    username string
    name string
    verified boolean
    profile_img string
    filters object[]
  • Array [
  • id integer
    from integer nullable
    to integer nullable
    indicator_text string
  • ]
  • tags object[]
  • Array [
  • id integer
    name string

    the #tag

  • ]
  • estimated_reading_time float

    Default value: 0

    The average time it takes to read the post

  • ]
  • pages integer
Loading...