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 value	Explanation	Required user login
newest	recent posts at top	No
following	return reflections of authors that current user is following	Yes
draft	returns current user's private notes	Yes
favorite	returns current user's favorite posts	Yes
most_popular	default tab value. Return most popular posts	No

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

• 200
• 401
• 404
• 500

---

User profile, notification and other settings and recent posts

application/json

Schema

Example (from schema)

Example 1

---

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

{
  "success": true,
  "user_info": {
    "id": 0,
    "username": "string",
    "name": "string",
    "first_name": "string",
    "last_name": "string",
    "verified": true,
    "followed": true,
    "rooms_list": [
      "string"
    ],
    "display_name": "string",
    "user_type": "string",
    "user_notifications_settings": [
      {
        "id": 0,
        "emails_disabled": true,
        "follow_notification": true,
        "followed_user_added_post_notification": true,
        "post_commented_notification": true,
        "post_liked_notification": true,
        "mention_notification": true,
        "added_post_in_group_notification": true,
        "follow_push_notification": true,
        "followed_user_added_post_push_notification": true,
        "post_commented_push_notification": true,
        "post_liked_push_notification": true,
        "mention_push_notification": true,
        "added_post_in_group_push_notification": true
      }
    ]
  },
  "posts_count": 0,
  "followers": 0,
  "followees": 0,
  "posts": {
    "posts": [
      {
        "id": 0,
        "body": "string",
        "likes": 0,
        "draft": true,
        "published_at": "string",
        "global": true,
        "editable": true,
        "deletable": true,
        "reportable": true,
        "citation_texts": [
          {
            "id": 0,
            "text": "string",
            "translated_name": "string",
            "from": 0,
            "to": 0,
            "translation_id": 0
          }
        ],
        "language": "string",
        "detected_translation": 0,
        "views": 0,
        "comments": [
          {}
        ],
        "liked": true,
        "author": {
          "id": 0,
          "username": "string",
          "name": "string",
          "verified": true,
          "profile_img": "string"
        },
        "filters": [
          {
            "id": 0,
            "from": 0,
            "to": 0,
            "indicator_text": "string"
          }
        ],
        "tags": [
          {
            "id": 0,
            "name": "string"
          }
        ],
        "estimated_reading_time": 55018.9
      }
    ]
  },
  "pages": 0
}

{
  "success": true,
  "user_info": {
    "id": 0,
    "username": "string",
    "name": "string",
    "first_name": "string",
    "last_name": "string",
    "verified": true,
    "profile_img": null,
    "followed": true,
    "original_profile_img": null,
    "rooms_list": [
      "string"
    ],
    "display_name": "string",
    "user_type": "string",
    "user_notifications_settings": [
      {
        "id": 0,
        "emails_disabled": true,
        "follow_notification": true,
        "followed_user_added_post_notification": true,
        "post_commented_notification": true,
        "post_liked_notification": true,
        "mention_notification": true,
        "added_post_in_group_notification": true,
        "follow_push_notification": true,
        "followed_user_added_post_push_notification": true,
        "post_commented_push_notification": true,
        "post_liked_push_notification": true,
        "mention_push_notification": true,
        "added_post_in_group_push_notification": true
      }
    ]
  },
  "posts_count": 0,
  "followers": 0,
  "followees": 0,
  "posts": {
    "posts": [
      {
        "id": 0,
        "body": "string",
        "likes": 0,
        "draft": true,
        "published_at": "string",
        "room_id": null,
        "global": true,
        "editable": true,
        "deletable": true,
        "reportable": true,
        "citation_texts": [
          {
            "id": 0,
            "text": "string",
            "translated_name": "string",
            "from": 0,
            "to": 0,
            "translation_id": 0
          }
        ],
        "language": "string",
        "detected_translation": 0,
        "views": 0,
        "group": null,
        "group_link": null,
        "comments": [
          {}
        ],
        "liked": true,
        "author": {
          "id": 0,
          "username": "string",
          "name": "string",
          "verified": true,
          "profile_img": "string"
        },
        "filters": [
          {
            "id": 0,
            "from": 0,
            "to": 0,
            "indicator_text": "string"
          }
        ],
        "tags": [
          {
            "id": 0,
            "name": "string"
          }
        ]
      }
    ]
  },
  "pages": 1
}

Unauthorized response, api will respond with this 401 eithr user is not logged in or do not have permission to perform some action. Like creating a post in a room, but user is not member of room.

System will also return 401 if api token is missing or invlaid.

application/json

Schema

Example (from schema)

not logged in

missing or invalid api key

---

Schema

errors string[]
status integer

Default value: 401

success boolean

Default value: false

{
  "errors": [
    "string"
  ],
  "status": 401,
  "success": false
}

{
  "errors": [
    "You need to sign in or sign up before continuing."
  ],
  "success": false
}

{
  "message": "You don't have permission!",
  "status": 401,
  "success": false
}

User not found with given username

application/json

Schema

Example (from schema)

Example 1

---

Schema

success boolean
message string

{
  "success": true,
  "message": "string"
}

{
  "success": false,
  "message": "Invalid User"
}

Internal server error, api will respond with 500 if something went wrong processing the request.

application/json

Schema

Example (from schema)

---

Schema

success boolean required

Default value: false

message string required

Default value: internal server error

error message

{
  "success": false,
  "message": "internal server error"
}

Loading...